asynq

Documentation

Index

• Constants
• type Option
  • func WithQueueName[T comparable](queue string) Option[T]
  • func WithTimerInterval[T comparable](interval time.Duration) Option[T]
• type Timer
  • func NewTimer[T comparable](redisOpt *asynq.RedisClientOpt, opts ...Option[T]) *Timer[T]
  • func (t *Timer[T]) Add(opType timer.OpType, id T, delay time.Duration) error
  • func (t *Timer[T]) Get(opType timer.OpType, id T) *timer.OperationItem[T]
  • func (t *Timer[T]) GetAll() []*timer.OperationItem[T]
  • func (t *Timer[T]) Register(opType timer.OpType, handler func(T))
  • func (t *Timer[T]) Remove(opType timer.OpType, id T) error
  • func (t *Timer[T]) Start()
  • func (t *Timer[T]) Stop()

Constants

const DefaultQueue = "default"

Types

type Option

type Option[T comparable] func(*Timer[T])

func WithQueueName

func WithQueueName[T comparable](queue string) Option[T]

func WithTimerInterval

func WithTimerInterval[T comparable](interval time.Duration) Option[T]

type Timer

type Timer[T comparable] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewTimer

func NewTimer[T comparable](redisOpt *asynq.RedisClientOpt, opts ...Option[T]) *Timer[T]

func (*Timer[T]) Add

func (t *Timer[T]) Add(opType timer.OpType, id T, delay time.Duration) error

func (*Timer[T]) Get

func (t *Timer[T]) Get(opType timer.OpType, id T) *timer.OperationItem[T]

func (*Timer[T]) GetAll

func (t *Timer[T]) GetAll() []*timer.OperationItem[T]

func (*Timer[T]) Register

func (t *Timer[T]) Register(opType timer.OpType, handler func(T))

func (*Timer[T]) Remove

func (t *Timer[T]) Remove(opType timer.OpType, id T) error

func (*Timer[T]) Start

func (t *Timer[T]) Start()

func (*Timer[T]) Stop

func (t *Timer[T]) Stop()