redis

Documentation

Index

• Variables
• func Backend(ctx context.Context, opts ...config.Option) (backend types.Backend, err error)
• func WithAddr(addr string) config.Option
• func WithConcurrency(concurrency int) config.Option
• func WithPassword(password string) config.Option
• func WithShutdownTimeout(timeout time.Duration) config.Option
• type RedisBackend
  • func (b *RedisBackend) Enqueue(ctx context.Context, job *jobs.Job) (jobID string, err error)
  • func (b *RedisBackend) SetLogger(logger logging.Logger)
  • func (b *RedisBackend) Shutdown(ctx context.Context)
  • func (b *RedisBackend) Start(_ context.Context, queue string, h handler.Handler) (err error)
  • func (b *RedisBackend) StartCron(ctx context.Context, cronSpec string, h handler.Handler) (err error)

Variables

var (
	// ErrInvalidAddr indicates that the provided address is not a valid redis connection string
	ErrInvalidAddr = errors.New("invalid connecton string: see documentation for valid connection strings")
)

Functions

func Backend

func Backend(ctx context.Context, opts ...config.Option) (backend types.Backend, err error)

Backend is a config.BackendInitializer that initializes a new Redis-backed neoq backend

func WithAddr

func WithAddr(addr string) config.Option

WithAddr configures neoq to connect to Redis with the given address

func WithConcurrency

func WithConcurrency(concurrency int) config.Option

WithConcurrency configures the number of workers available to process jobs across all queues

func WithPassword

func WithPassword(password string) config.Option

WithPassword configures neoq to connect to Redis with the given password

func WithShutdownTimeout

func WithShutdownTimeout(timeout time.Duration) config.Option

WithShutdownTimeout specifies the duration to wait to let workers finish their tasks before forcing them to abort durning Shutdown()

If unset or zero, default timeout of 8 seconds is used.

Types

type RedisBackend

type RedisBackend struct {
	types.Backend
	// contains filtered or unexported fields
}

RedisBackend is a Redis-backed neoq backend nolint: revive

func (*RedisBackend) Enqueue

func (b *RedisBackend) Enqueue(ctx context.Context, job *jobs.Job) (jobID string, err error)

Enqueue queues jobs to be executed asynchronously

func (*RedisBackend) SetLogger

func (b *RedisBackend) SetLogger(logger logging.Logger)

SetLogger sets this backend's logger

func (*RedisBackend) Shutdown

func (b *RedisBackend) Shutdown(ctx context.Context)

Shutdown halts the worker

func (*RedisBackend) Start

func (b *RedisBackend) Start(_ context.Context, queue string, h handler.Handler) (err error)

Start starts processing jobs with the specified queue and handler

func (*RedisBackend) StartCron

func (b *RedisBackend) StartCron(ctx context.Context, cronSpec string, h handler.Handler) (err error)

StartCron starts processing jobs with the specified cron schedule and handler

See: https://pkg.go.dev/github.com/robfig/cron?#hdr-CRON_Expression_Format for details on the cron spec format