queue

README

Queue

Queue is a Golang library for spawning and managing a Goroutine pool, Alloowing you to create multiple worker according to limit CPU number of machine.

Documentation

Index

• Variables
• type Logger
• type Option
  • func WithLogger(l Logger) Option
  • func WithWorker(w Worker) Option
  • func WithWorkerCount(num int) Option
• type Queue
  • func NewQueue(opts ...Option) (*Queue, error)
  • func (q *Queue) Capacity() int
  • func (q *Queue) Queue(job QueuedMessage) error
  • func (q *Queue) Shutdown()
  • func (q *Queue) Start()
  • func (q *Queue) Usage() int
  • func (q *Queue) Wait()
  • func (q *Queue) Workers() int
• type QueuedMessage
• type Worker

Variables

var ErrMissingWorker = errors.New("missing worker module")

ErrMissingWorker missing define worker

Types

type Logger

type Logger interface {
	Infof(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
	Info(args ...interface{})
	Error(args ...interface{})
	Fatal(args ...interface{})
}

Logger interface is used throughout gorush

type Option

type Option func(*Queue)

Option for queue system

func WithLogger

func WithLogger(l Logger) Option

WithLogger set custom logger

func WithWorker

func WithWorker(w Worker) Option

WithWorker set custom worker

func WithWorkerCount

func WithWorkerCount(num int) Option

WithWorkerCount set worker count

type Queue

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

A Queue is a message queue.

func NewQueue

func NewQueue(opts ...Option) (*Queue, error)

NewQueue returns a Queue.

func (*Queue) Capacity

func (q *Queue) Capacity() int

Capacity for queue max size

func (*Queue) Queue

func (q *Queue) Queue(job QueuedMessage) error

Queue to queue all job

func (*Queue) Shutdown

func (q *Queue) Shutdown()

Shutdown stops all queues.

func (*Queue) Start

func (q *Queue) Start()

Start to enable all worker

func (*Queue) Usage

func (q *Queue) Usage() int

Usage for count of queue usage

func (*Queue) Wait

func (q *Queue) Wait()

Wait all process

func (*Queue) Workers

func (q *Queue) Workers() int

Workers returns the numbers of workers has been created.

type QueuedMessage

type QueuedMessage interface {
	Bytes() []byte
}

QueuedMessage ...

type Worker

type Worker interface {
	// BeforeRun is called before starting the worker
	BeforeRun() error
	// Run is called to start the worker
	Run(chan struct{}) error
	// BeforeRun is called after starting the worker
	AfterRun() error
	// Shutdown is called if stop all worker
	Shutdown() error
	// Queue to send message in Queue (single channel, NSQ or AWS SQS)
	Queue(job QueuedMessage) error
	// Capacity queue capacity = cap(channel name)
	Capacity() int
	// Usage is how many message in queue
	Usage() int
}

Worker interface