go-timer

KO | EN

gitlite — search

#javascript #go #golang #rust #linux #macos #nodejs #windows #cli #kubernetes #vue #security #mcp #open-source

(★ 70)

⏰ A fast go timer with minimal goroutines.

go-timer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# GO-TIMER

[![Go](https://github.com/singchia/go-xtables/actions/workflows/go.yml/badge.svg)](https://github.com/singchia/go-xtables/actions/workflows/go.yml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Go Report Card](https://goreportcard.com/badge/github.com/singchia/go-timer/v2)](https://goreportcard.com/report/github.com/singchia/go-timer/v2)

## Overview

A high performance timer with minimal goroutines.

### How it works

![](https://raw.githubusercontent.com/singchia/go-timer/main/docs/overview.jpg)

### Features

* One goroutine runs all
* Goroutine safe
* Clean and simple, no third-party deps at all
* High performance with timing-wheels algorithm
* Minimal resources use
* Managed data and handler
* Customizing channel
* Well tested

## Usage

### Quick Start

```golang
package main

import (
	"log"
	"time"

timer "github.com/singchia/go-timer/v2"
)

func main() {
	t1 := time.Now()
	// new timer
	t := timer.NewTimer()
	// add a tick in 1s
	tick := t.Add(time.Second)
	// wait for it
	<-tick.C()
	// tick fired as time is up, calculate and print the elapse
	log.Printf("time elapsed: %fs\n", time.Now().Sub(t1).Seconds())
}
```

### Async handler

```golang
package main

import (
	"log"
	"sync"
	"time"

timer "github.com/singchia/go-timer/v2"
)

func main() {
	// we need a wait group since using async handler
	wg := sync.WaitGroup{}
	wg.Add(1)
	// new timer
	t := timer.NewTimer()
	// add a tick in 1s with current time and a async handler
	t.Add(time.Second, timer.WithData(time.Now()), timer.WithHandler(func(event *timer.Event) {
		defer wg.Done()
		// tick fired as time is up, calculate and print the elapse
		log.Printf("time elapsed: %fs\n", time.Now().Sub(event.Data.(time.Time)).Seconds())
	}))

wg.Wait()
}
```

### With cyclically

```golang
package main

import (
	"log"
	"time"

timer "github.com/singchia/go-timer/v2"
)

func main() {
	t1 := time.Now()
	// new timer
	t := timer.NewTimer()
	// add cyclical tick in 1s
	tick := t.Add(time.Second, timer.WithCyclically())
	for {
		// wait for it cyclically
		<-tick.C()
		t2 := time.Now()
		// calculate and print the elapse
		log.Printf("time elapsed: %fs\n", t2.Sub(t1).Seconds())
		t1 = t2
	}
}
```

## License

Released under the [Apache License 2.0](https://github.com/singchia/go-timer/blob/master/LICENSE)

go-timer

go-timer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

go-timer

go-timer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README