tickque

README

tickque

A job queue designed especially for server tick/update/heartbeat.

Documentation

Index

• func Recycle(job *Job)
• type Job
  • func (j *Job) Hint() int64
  • func (j *Job) RetryNumber() int32
• type JobHandler
• type Option
  • func WithMaxTickTime(d time.Duration) Option
  • func WithNumBurstThreads(n int) Option
• type Tickque
  • func NewTickque(logger slog.Logger, opts ...Option) (tq *Tickque)
  • func (tq *Tickque) AddBurstJob(hint int64, jobType string, jobData live.Data)
  • func (tq *Tickque) AddJob(jobType string, jobData live.Data)
  • func (tq *Tickque) NumPendingJobs() int
  • func (tq *Tickque) Postpone(job *Job)
  • func (tq *Tickque) Shutdown(ctx context.Context, jobHandler JobHandler) (int, error)
  • func (tq *Tickque) Tick(maxJobs int, jobHandler JobHandler) int

Functions

func Recycle

func Recycle(job *Job)

Types

type Job

type Job struct {
	Type string
	Data live.Data
	// contains filtered or unexported fields
}

func (*Job) Hint

func (j *Job) Hint() int64

func (*Job) RetryNumber

func (j *Job) RetryNumber() int32

type JobHandler

type JobHandler func(job *Job) error

type Option

type Option func(tq *Tickque)

func WithMaxTickTime

func WithMaxTickTime(d time.Duration) Option

func WithNumBurstThreads

func WithNumBurstThreads(n int) Option

type Tickque

type Tickque struct {
	slog.Logger
	// contains filtered or unexported fields
}

func NewTickque

func NewTickque(logger slog.Logger, opts ...Option) (tq *Tickque)

func (*Tickque) AddBurstJob

func (tq *Tickque) AddBurstJob(hint int64, jobType string, jobData live.Data)

func (*Tickque) AddJob

func (tq *Tickque) AddJob(jobType string, jobData live.Data)

func (*Tickque) NumPendingJobs

func (tq *Tickque) NumPendingJobs() int

func (*Tickque) Postpone

func (tq *Tickque) Postpone(job *Job)

func (*Tickque) Shutdown

func (tq *Tickque) Shutdown(ctx context.Context, jobHandler JobHandler) (int, error)

func (*Tickque) Tick

func (tq *Tickque) Tick(maxJobs int, jobHandler JobHandler) int