queue

Jan 19, 2025

Changes in this version

type Metric

+ CompletedTasks func() uint64

+ IncCompletedTask func()

type Option

+ func WithAfterFn(afterFn func()) Option

type Queue

+ func (q *Queue) CompletedTasks() uint64

Dec 5, 2023

Changes in this version

+ var ErrMaxCapacity = errors.New("golang-queue: maximum size limit reached")

+ type Ring struct

+ func NewRing(opts ...Option) *Ring

+ func (s *Ring) Queue(task core.QueuedMessage) error

+ func (s *Ring) Request() (core.QueuedMessage, error)

+ func (s *Ring) Run(ctx context.Context, task core.QueuedMessage) error

+ func (s *Ring) Shutdown() error

Apr 26, 2022

Changes in this version

+ var ErrNoTaskInQueue = errors.New("golang-queue: no task in queue")

+ var ErrQueueHasBeenClosed = errors.New("golang-queue: queue has been closed")

type Consumer

+ func (s *Consumer) Request() (core.QueuedMessage, error)

type Metric

+ FailureTasks func() uint64

+ IncFailureTask func()

+ IncSubmittedTask func()

+ IncSuccessTask func()

+ SubmittedTasks func() uint64

+ SuccessTasks func() uint64

type Option

+ Apply func(*Options)

+ type OptionFunc func(*Options)

+ func (f OptionFunc) Apply(option *Options)

type Queue

+ func (q *Queue) BusyWorkers() int

+ func (q *Queue) FailureTasks() int

+ func (q *Queue) SubmittedTasks() int

+ func (q *Queue) SuccessTasks() int

+ func (q *Queue) UpdateWorkerCount(num int)

Mar 7, 2022

Changes in this version

type Job

+ Payload []byte

Dec 24, 2021

Changes in this version

type Metric

+ func NewMetric() Metric

Dec 24, 2021

Changes in this version

+ type Metric interface

+ BusyWorkers func() uint64

+ DecBusyWorker func()

+ IncBusyWorker func()

type Option

+ func WithMetric(m Metric) Option

Dec 15, 2021

Changes in this version

type Option

+ func WithTimeOut(t time.Duration) Option

Sep 7, 2021

Changes in this version

type Consumer

+ func (s *Consumer) BusyWorkers() uint64

type Worker

+ BusyWorkers func() uint64

Aug 21, 2021

Changes in this version

+ type Consumer struct

+ func NewConsumer(opts ...Option) *Consumer

+ func (s *Consumer) AfterRun() error

+ func (s *Consumer) BeforeRun() error

+ func (s *Consumer) Capacity() int

+ func (s *Consumer) Queue(job QueuedMessage) error

+ func (s *Consumer) Run() error

+ func (s *Consumer) Shutdown() error

+ func (s *Consumer) Usage() int

type Option

+ func WithFn(fn func(context.Context, QueuedMessage) error) Option

+ func WithQueueSize(num int) Option

+ type Options struct

+ func NewOptions(opts ...Option) *Options

type Queue

+ func NewPool(size int, opts ...Option) *Queue

+ func (q *Queue) Release()

Aug 15, 2021

Changes in this version

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

+ var ErrQueueShutdown = errors.New("queue has been closed and released")

+ type Job struct

+ Body []byte

+ Task TaskFunc

+ Timeout time.Duration

+ func (j Job) Bytes() []byte

+ func (j Job) Encode() []byte

+ type Logger interface

+ Error func(args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Fatal func(args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ Info func(args ...interface{})

+ Infof func(format string, args ...interface{})

+ func NewEmptyLogger() Logger

+ func NewLogger() Logger

+ type Option func(*Queue)

+ func WithLogger(l Logger) Option

+ func WithWorker(w Worker) Option

+ func WithWorkerCount(num int) Option

+ type Queue struct

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

+ func (q *Queue) Capacity() int

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

+ func (q *Queue) QueueTask(task TaskFunc) error

+ func (q *Queue) QueueTaskWithTimeout(timeout time.Duration, task TaskFunc) error

+ func (q *Queue) QueueWithTimeout(timeout time.Duration, 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 interface

+ Bytes func() []byte

+ type TaskFunc func(context.Context) error

+ type Worker interface

+ AfterRun func() error

+ BeforeRun func() error

+ Capacity func() int

+ Queue func(job QueuedMessage) error

+ Run func() error

+ Shutdown func() error

+ Usage func() int