redisdb

README

redis

Redis as backend for Queue package

Setup

start the redis server

redis-server

Testing

go test -v ./...

Documentation

Index

• type Option
  • func WithAddr(addr string) Option
  • func WithChannel(channel string) Option
  • func WithChannelSize(size int) Option
  • func WithConnectionString(connectionString string) Option
  • func WithDB(db int) Option
  • func WithLogger(l queue.Logger) Option
  • func WithPassword(passwd string) Option
  • func WithRunFunc(fn func(context.Context, queue.QueuedMessage) error) Option
• type Worker
  • func NewWorker(opts ...Option) *Worker
  • func (s *Worker) AfterRun() error
  • func (s *Worker) BeforeRun() error
  • func (s *Worker) Capacity() int
  • func (s *Worker) Queue(job queue.QueuedMessage) error
  • func (s *Worker) Run() error
  • func (s *Worker) Shutdown() error
  • func (s *Worker) Usage() int

Types

type Option

type Option func(*Worker)

Option for queue system

func WithAddr

func WithAddr(addr string) Option

WithAddr setup the addr of redis

func WithChannel

func WithChannel(channel string) Option

WithChannel setup the channel of redis

func WithChannelSize

func WithChannelSize(size int) Option

WithChannelSize redis channel size

func WithConnectionString

func WithConnectionString(connectionString string) Option

WithConnectionString redis connection string

func WithDB

func WithDB(db int) Option

WithPassword redis password

func WithLogger

func WithLogger(l queue.Logger) Option

WithLogger set custom logger

func WithPassword

func WithPassword(passwd string) Option

WithPassword redis password

func WithRunFunc

func WithRunFunc(fn func(context.Context, queue.QueuedMessage) error) Option

WithRunFunc setup the run func of queue

type Worker

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

Worker for Redis

func NewWorker

func NewWorker(opts ...Option) *Worker

NewWorker for struc

func (*Worker) AfterRun

func (s *Worker) AfterRun() error

AfterRun run script after start worker

func (*Worker) BeforeRun

func (s *Worker) BeforeRun() error

BeforeRun run script before start worker

func (*Worker) Capacity

func (s *Worker) Capacity() int

Capacity for channel

func (*Worker) Queue

func (s *Worker) Queue(job queue.QueuedMessage) error

Queue send notification to queue

func (*Worker) Run

func (s *Worker) Run() error

Run start the worker

func (*Worker) Shutdown

func (s *Worker) Shutdown() error

Shutdown worker

func (*Worker) Usage

func (s *Worker) Usage() int

Usage for count of channel usage