timewheel

Documentation

Index

• type Option
  • func WithGoPool(goPool *gopool.GoroutinePool) Option
• type Task
  • func (t *Task) Reset()
• type Ticker
  • func (t *Ticker) Stop()
• type TimeWheel
  • func NewTimeWheel(tick time.Duration, bucketsNum int, options ...Option) (*TimeWheel, error)
  • func (tw *TimeWheel) Add(delay time.Duration, callback func()) *Task
  • func (tw *TimeWheel) AddCron(delay time.Duration, callback func()) *Task
  • func (tw *TimeWheel) After(delay time.Duration) <-chan time.Time
  • func (tw *TimeWheel) AfterFunc(delay time.Duration, callback func()) *Timer
  • func (tw *TimeWheel) NewTicker(delay time.Duration) *Ticker
  • func (tw *TimeWheel) NewTimer(delay time.Duration) *Timer
  • func (tw *TimeWheel) Remove(task *Task) error
  • func (tw *TimeWheel) Sleep(delay time.Duration)
  • func (tw *TimeWheel) Start()
  • func (tw *TimeWheel) Stop()
• type Timer
  • func (t *Timer) AddStopFunc(callback func())
  • func (t *Timer) Reset(delay time.Duration)
  • func (t *Timer) Stop()

Types

type Option

type Option func(*TimeWheel) error

func WithGoPool

func WithGoPool(goPool *gopool.GoroutinePool) Option

WithGoPool

@Description: 设置执行池
@param goPool
@return Option

type Task

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

func (*Task) Reset

func (t *Task) Reset()

Reset for sync.Pool

type Ticker

type Ticker struct {
	C   chan bool
	Ctx context.Context
	// contains filtered or unexported fields
}

func (*Ticker) Stop

func (t *Ticker) Stop()

type TimeWheel

type TimeWheel struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

TimeWheel

@Description: 时间轮 的实现
	代码参考自 https://github.com/rfyiamcool/go-timewheel

func NewTimeWheel

func NewTimeWheel(tick time.Duration, bucketsNum int, options ...Option) (*TimeWheel, error)

NewTimeWheel create new time wheel

func (*TimeWheel) Add

func (tw *TimeWheel) Add(delay time.Duration, callback func()) *Task

Add to add a task

func (*TimeWheel) AddCron

func (tw *TimeWheel) AddCron(delay time.Duration, callback func()) *Task

AddCron add interval task

func (*TimeWheel) After

func (tw *TimeWheel) After(delay time.Duration) <-chan time.Time

func (*TimeWheel) AfterFunc

func (tw *TimeWheel) AfterFunc(delay time.Duration, callback func()) *Timer

func (*TimeWheel) NewTicker

func (tw *TimeWheel) NewTicker(delay time.Duration) *Ticker

func (*TimeWheel) NewTimer

func (tw *TimeWheel) NewTimer(delay time.Duration) *Timer

func (*TimeWheel) Remove

func (tw *TimeWheel) Remove(task *Task) error

func (*TimeWheel) Sleep

func (tw *TimeWheel) Sleep(delay time.Duration)

func (*TimeWheel) Start

func (tw *TimeWheel) Start()

Start to start the time wheel

func (*TimeWheel) Stop

func (tw *TimeWheel) Stop()

Stop to stop the time wheel

type Timer

type Timer struct {
	C chan bool

	Ctx context.Context
	// contains filtered or unexported fields
}

Timer similar to golang std timer

func (*Timer) AddStopFunc

func (t *Timer) AddStopFunc(callback func())

func (*Timer) Reset

func (t *Timer) Reset(delay time.Duration)

func (*Timer) Stop

func (t *Timer) Stop()