README
¶
timer
Go implementation of Kafka's Hierarchical Timing Wheels.
Feature
- Unlimited hierarchical wheel.
insert,delete,scantask almost O(1).- Different from the time wheel of Linux, it has no maximum time limit.
- Support millions of tasks.
timedis a globaltimerinstance, that tick is 1ms. wheel size is 512, use ants goroutine pool.
Usage
Installation
Use go get.
go get github.com/thinkgos/timer
Then import the package into your own code.
import "github.com/thinkgos/timer"
Example
use global timer instance.
package main
import (
"fmt"
"sync"
"time"
"github.com/thinkgos/timer/timed"
)
func main() {
var wg sync.WaitGroup
for i := 0; i < 1000; i++ {
wg.Add(1)
index := i
_, _ = timed.AfterFunc(time.Duration(i)*100*time.Millisecond, func() {
fmt.Printf("%s: timer task %d is executed, remain task: %d\n", time.Now().String(), index, timed.TaskCounter())
wg.Done()
})
}
wg.Wait()
}
References
License
This project is under MIT License. See the LICENSE file for the full license text.
Documentation
¶
Index ¶
- Constants
- Variables
- func CompareSpoke(sp1, sp2 *Spoke) int
- func IsPowOf2(x int) bool
- func NextPowOf2(x int) int
- type GoPool
- type Job
- type JobFunc
- type Option
- type Spoke
- type Task
- type Timer
- func (t *Timer) AddTask(task *Task) error
- func (t *Timer) AfterFunc(d time.Duration, f func()) (*Task, error)
- func (t *Timer) Start()
- func (t *Timer) Started() bool
- func (t *Timer) Stop()
- func (t *Timer) TaskCounter() int64
- func (t *Timer) TickMs() int64
- func (t *Timer) WheelMask() int
- func (t *Timer) WheelSize() int
- type TimingWheel
Examples ¶
Constants ¶
const ( // DefaultTickMs default tick milliseconds. DefaultTickMs = 1 // DefaultWheelSize default wheel size. DefaultWheelSize = 512 )
Variables ¶
var ErrClosed = errors.New("timer: use of closed timer")
ErrClosed is returned when the timer is closed.
Functions ¶
func CompareSpoke ¶ added in v0.5.2
CompareSpoke compare two `Spoke` with expiration.
Types ¶
type Spoke ¶
type Spoke struct {
// contains filtered or unexported fields
}
Spoke a spoke of the wheel.
func (*Spoke) Flush ¶
func (sp *Spoke) Flush(f func(*taskEntry))
Flush all task entries and apply the supplied function to each of them
func (*Spoke) GetExpiration ¶
GetExpiration the spoke's expiration time
func (*Spoke) Remove ¶
func (sp *Spoke) Remove(te *taskEntry)
Remove the specified timer task from this list
func (*Spoke) SetExpiration ¶
SetExpiration the spoke's expiration time Returns true if the expiration time is changed
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Task timer task.
func NewTaskFunc ¶
NewTaskFunc new task with delay duration and function job, the accuracy is milliseconds.
func NewTaskJob ¶ added in v0.5.2
NewTaskJob new task with delay duration and job, the accuracy is milliseconds.
type Timer ¶
type Timer struct {
// contains filtered or unexported fields
}
Timer is a timer
Example ¶
tm := NewTimer()
tm.Start()
_, _ = tm.AfterFunc(100*time.Millisecond, func() {
fmt.Println(100)
})
canceledTaskThenAddAgain := NewTask(1100 * time.Millisecond).WithJobFunc(func() {
fmt.Println("canceled then add again")
})
_ = tm.AddTask(canceledTaskThenAddAgain)
canceledTaskThenAddAgain.Cancel()
_ = tm.AddTask(NewTask(1025 * time.Millisecond).WithJobFunc(func() {
fmt.Println(200)
}))
_ = tm.AddTask(canceledTaskThenAddAgain)
time.Sleep(time.Second + time.Millisecond*200)
tm.Stop()
Output: 100 200 canceled then add again
func (*Timer) Stop ¶
func (t *Timer) Stop()
Stop the timer, graceful shutdown waiting the goroutine until it's stopped.
func (*Timer) TaskCounter ¶
TaskCounter the total number of tasks.
type TimingWheel ¶
type TimingWheel struct {
// contains filtered or unexported fields
}
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
_examples
|
|
|
monitor
command
|
|
|
repetition
command
|
|
|
sample
command
|
|
|
go
|
|
|
heap
Package heap provides heap operations for any type that implements heap.Interface.
|
Package heap provides heap operations for any type that implements heap.Interface. |