timer

Documentation

Index

• Constants
• func ClearInterval(id ID)
• func ClearTimeout(id ID)
• type ID
  • func SetInterval(d time.Duration, task Task) ID
  • func SetIntervalFunc(d time.Duration, fn TaskFunc) ID
  • func SetTimeout(d time.Duration, task Task) ID
  • func SetTimeoutFunc(d time.Duration, fn TaskFunc) ID
  • func (id ID) Valid() bool
• type Scheduler
  • func NewMemoryScheduler() Scheduler
• type Task
• type TaskFunc
  • func (fn TaskFunc) ExecTimer(id ID)
• type Ticker
  • func NewTicker(interval time.Duration) *Ticker
  • func (t *Ticker) Interval() time.Duration
  • func (t *Ticker) Next(now time.Time) bool

Constants

const Forever = -1

Functions

func ClearInterval

func ClearInterval(id ID)

ClearTimeout removes the interval timer by ID

func ClearTimeout

func ClearTimeout(id ID)

ClearTimeout removes the timeout timer by ID

Types

type ID

type ID int64

ID represents ID of timer task

func SetInterval

func SetInterval(d time.Duration, task Task) ID

SetInterval add interval timer

func SetIntervalFunc

func SetIntervalFunc(d time.Duration, fn TaskFunc) ID

SetIntervalFunc add a interval timer func

func SetTimeout

func SetTimeout(d time.Duration, task Task) ID

SetTimeout add a timeout timer

func SetTimeoutFunc

func SetTimeoutFunc(d time.Duration, fn TaskFunc) ID

SetTimeoutFunc add a timeout timer func

func (ID) Valid

func (id ID) Valid() bool

type Scheduler

type Scheduler interface {
	// Start starts the Scheduler
	Start() error
	// Shutdown shutdowns the Scheduler
	Shutdown()
	// Add adds a new timer task
	Add(next, duration time.Duration, task Task, times int) ID
	// Remove removes a timer task by ID
	Remove(id ID)
}

Scheduler schedules timers

func NewMemoryScheduler

func NewMemoryScheduler() Scheduler

NewMemoryScheduler creates in-memory Scheduler

type Task

type Task interface {
	ExecTimer(ID)
}

Task represents timer task

type TaskFunc

type TaskFunc func(ID)

TaskFunc wraps function as a task

func (TaskFunc) ExecTimer

func (fn TaskFunc) ExecTimer(id ID)

ExecTimer implements Task ExecTimer method

type Ticker

type Ticker struct {
	// contains filtered or unexported fields
}

func NewTicker

func NewTicker(interval time.Duration) *Ticker

func (*Ticker) Interval

func (t *Ticker) Interval() time.Duration

func (*Ticker) Next

func (t *Ticker) Next(now time.Time) bool