scheduler

Documentation

Index

• func Close()
• func Digest()
• func PushTask(task Task)
• func Schedule(_ *session.Session, _ interface{}, task Task)
• type SchedFunc
• type Task
• type Timer
  • func NewAfterTimer(duration time.Duration, fn TimerFunc) *Timer
  • func NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer
  • func NewCountTimer(interval time.Duration, count int, fn TimerFunc) *Timer
  • func NewTimer(interval time.Duration, fn TimerFunc) *Timer
  • func (t *Timer) ID() int64
  • func (t *Timer) Stop()
• type TimerCondition
• type TimerFunc
• type TimerManager
  • func NewTimerManager() *TimerManager
  • func (tm *TimerManager) Cron()
  • func (tm *TimerManager) NewAfterTimer(duration time.Duration, fn TimerFunc) *Timer
  • func (tm *TimerManager) NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer
  • func (tm *TimerManager) NewCountTimer(interval time.Duration, count int, fn TimerFunc) *Timer
  • func (tm *TimerManager) NewTimer(interval time.Duration, fn TimerFunc) *Timer

Functions

func Close

func Close()

Close closes scheduler.

func Digest

func Digest()

Digest pops tasks from task channel, and handle them.

func PushTask

func PushTask(task Task)

PushTask pushes task in task channel

func Schedule

func Schedule(_ *session.Session, _ interface{}, task Task)

Schedule is to fill the default func for Service.Schedule

Types

type SchedFunc

type SchedFunc func(session *session.Session, v interface{}, task Task)

SchedFunc is the Func type of schedule

type Task

type Task func()

Task is the unit to be scheduled

type Timer

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

Timer represents a cron job

func NewAfterTimer

func NewAfterTimer(duration time.Duration, fn TimerFunc) *Timer

NewAfterTimer returns a new Timer containing a function that will be called after duration that specified by the duration argument. The duration d must be greater than zero; if not, NewAfterTimer will panic. Stop the timer to release associated resources.

func NewCondTimer

func NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer

NewCondTimer returns a new Timer containing a function that will be called when condition satisfied that specified by the condition argument. The duration d must be greater than zero; if not, NewCondTimer will panic. Stop the timer to release associated resources.

func NewCountTimer

func NewCountTimer(interval time.Duration, count int, fn TimerFunc) *Timer

NewCountTimer returns a new Timer containing a function that will be called with a period specified by the duration argument. After count times, timer will be stopped automatically, It adjusts the intervals for slow receivers. The duration d must be greater than zero; if not, NewCountTimer will panic. Stop the timer to release associated resources.

func NewTimer

func NewTimer(interval time.Duration, fn TimerFunc) *Timer

NewTimer returns a new Timer containing a function that will be called with a period specified by the duration argument. It adjusts the intervals for slow receivers. The duration d must be greater than zero; if not, NewTimer will panic. Stop the timer to release associated resources.

func (*Timer) ID

func (t *Timer) ID() int64

ID returns id of current timer

func (*Timer) Stop

func (t *Timer) Stop()

Stop turns off a timer. After Stop, fn will not be called forever

type TimerCondition

type TimerCondition interface {
	Check(now time.Time) bool
}

TimerCondition represents a checker that returns true when cron job needs to execute

type TimerFunc

type TimerFunc func()

TimerFunc represents a function which will be called periodically in main logic gorontine.

type TimerManager

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

func NewTimerManager

func NewTimerManager() *TimerManager

func (*TimerManager) Cron

func (tm *TimerManager) Cron()

func (*TimerManager) NewAfterTimer

func (tm *TimerManager) NewAfterTimer(duration time.Duration, fn TimerFunc) *Timer

NewAfterTimer returns a new Timer containing a function that will be called after duration that specified by the duration argument. The duration d must be greater than zero; if not, NewAfterTimer will panic. Stop the timer to release associated resources.

func (*TimerManager) NewCondTimer

func (tm *TimerManager) NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer

NewCondTimer returns a new Timer containing a function that will be called when condition satisfied that specified by the condition argument. The duration d must be greater than zero; if not, NewCondTimer will panic. Stop the timer to release associated resources.

func (*TimerManager) NewCountTimer

func (tm *TimerManager) NewCountTimer(interval time.Duration, count int, fn TimerFunc) *Timer

NewCountTimer returns a new Timer containing a function that will be called with a period specified by the duration argument. After count times, timer will be stopped automatically, It adjusts the intervals for slow receivers. The duration d must be greater than zero; if not, NewCountTimer will panic. Stop the timer to release associated resources.

func (*TimerManager) NewTimer

func (tm *TimerManager) NewTimer(interval time.Duration, fn TimerFunc) *Timer

NewTimer returns a new Timer containing a function that will be called with a period specified by the duration argument. It adjusts the intervals for slow receivers. The duration d must be greater than zero; if not, NewTimer will panic. Stop the timer to release associated resources.