Documentation
¶
Overview ¶
Example (StartTimer) ¶
package main
import (
"fmt"
"time"
"github.com/Allenxuxu/eviop/timingwheel"
)
func main() {
tw := timingwheel.NewTimingWheel(time.Millisecond, 20)
tw.Start()
defer tw.Stop()
exitC := make(chan time.Time, 1)
tw.AfterFunc(time.Second, func() {
fmt.Println("The timer fires")
exitC <- time.Now()
})
<-exitC
}
Output: The timer fires
Example (StopTimer) ¶
package main
import (
"fmt"
"time"
"github.com/Allenxuxu/eviop/timingwheel"
)
func main() {
tw := timingwheel.NewTimingWheel(time.Millisecond, 20)
tw.Start()
defer tw.Stop()
t := tw.AfterFunc(time.Second, func() {
fmt.Println("The timer fires")
})
<-time.After(900 * time.Millisecond)
// Stop the timer before it fires
t.Stop()
}
Output:
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Timer ¶
type Timer struct {
// contains filtered or unexported fields
}
Timer represents a single event. When the Timer expires, the given task will be executed.
func (*Timer) Stop ¶
Stop prevents the Timer from firing. It returns true if the call stops the timer, false if the timer has already expired or been stopped.
If the timer t has already expired and the t.task has been started in its own goroutine; Stop does not wait for t.task to complete before returning. If the caller needs to know whether t.task is completed, it must coordinate with t.task explicitly.
type TimingWheel ¶
type TimingWheel struct {
// contains filtered or unexported fields
}
TimingWheel is an implementation of Hierarchical Timing Wheels.
func NewTimingWheel ¶
func NewTimingWheel(tick time.Duration, wheelSize int64) *TimingWheel
NewTimingWheel creates an instance of TimingWheel with the given tick and wheelSize.
func (*TimingWheel) AfterFunc ¶
func (tw *TimingWheel) AfterFunc(d time.Duration, f func()) *Timer
AfterFunc waits for the duration to elapse and then calls f in its own goroutine. It returns a Timer that can be used to cancel the call using its Stop method.
func (*TimingWheel) Stop ¶
func (tw *TimingWheel) Stop()
Stop stops the current timing wheel.
If there is any timer's task being running in its own goroutine, Stop does not wait for the task to complete before returning. If the caller needs to know whether the task is completed, it must coordinate with the task explicitly.
Source Files
Directories