redcron

Documentation

Overview

Package redcron is distributed timers.

Index

• type Option
  • func WithSpec(spec string) Option
  • func WithTRPCOption(trpcOptions ...client.Option) Option
• type RedCron
  • func New(cmdable redis.Cmdable, opts ...cron.Option) (*RedCron, error)
  • func (c *RedCron) AddFunc(name string, f filter.ClientHandleFunc, opts ...Option) (cron.EntryID, error)
  • func (c *RedCron) Start()
  • func (c *RedCron) Stop()
• type Request
• type Response

Types

type Option

type Option func(r *Request)

Option is parameter.

func WithSpec

func WithSpec(spec string) Option

WithSpec modifies the timer time description.

func WithTRPCOption

func WithTRPCOption(trpcOptions ...client.Option) Option

WithTRPCOption adds trpc option。

type RedCron

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

RedCron is distributed timing task object.

func New

func New(cmdable redis.Cmdable, opts ...cron.Option) (*RedCron, error)

New creates a new distributed scheduled task object.

func (*RedCron) AddFunc

func (c *RedCron) AddFunc(name string, f filter.ClientHandleFunc, opts ...Option) (cron.EntryID, error)

AddFunc adds tasks through functions. If target does not exist, it means that the scheduled task will not be executed, and EntryID=0 will be returned.

func (*RedCron) Start

func (c *RedCron) Start()

Start starts the timer.

func (*RedCron) Stop

func (c *RedCron) Stop()

Stop stops the timer.

type Request

type Request struct {
	EntryID cron.EntryID // Timing task ID.
	Spec    string       // cron timing time description string.
	// contains filtered or unexported fields
}

Request is filter request body.

type Response

type Response struct {
	IsRun        bool      // Whether to be executed.
	NotRunReason string    // Reason for not running.
	Now          time.Time // Current time
	Store        time.Time // Redis stores time.
	Prev         time.Time // Current timer execution time.
	Next         time.Time // The next execution time of the timer.
	Cas          int64     // Redis CAS is convenient for locating problems.
	LastErr      error     // Last error.
}

Response is the filter response body.