scheduler

Documentation

Index

• Constants
• func Close()
• func NewScheduler() *scheduler
• func PushTask(task Task)
• func Schedule(_ *session.Session, _ interface{}, task Task)
• type Context
• type ScheduleFunc
• type Scheduler
  • func Global() Scheduler
• 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

Constants

const (
	Infinite = -1
)

Functions

func Close

func Close()

func NewScheduler

func NewScheduler() *scheduler

NewScheduler creates a new TimerScheduler

func PushTask

func PushTask(task Task)

func Schedule

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

Types

type Context

type Context struct {
	ServiceName string
	HandlerName string
	Data        interface{}
}

type ScheduleFunc

type ScheduleFunc func(*session.Session, *Context, Task)

type Scheduler

type Scheduler interface {
	TimerManager
	Schedule(*session.Session, *Context, Task)
	PushTask(task Task)
	Digest()
	Close()
}

func Global

func Global() Scheduler

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

func NewCondTimer

func NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer

func NewCountTimer

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

func NewTimer

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

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 interface {
	NewCountTimer(interval time.Duration, count int, fn TimerFunc) *Timer
	NewAfterTimer(duration time.Duration, fn TimerFunc) *Timer
	NewCondTimer(condition TimerCondition, fn TimerFunc) *Timer
	NewTimer(interval time.Duration, fn TimerFunc) *Timer
	TaskChan() <-chan Task
	CloseTimer()
}

func NewTimerManager

func NewTimerManager() TimerManager