work

Feb 17, 2022

Changes in this version

type QueueMetrics

+ Latency time.Duration

Jul 21, 2021

Changes in this version

+ type RedisQueue interface

Jun 30, 2021

Changes in this version

+ type BackoffFunc func(*Job, *DequeueOptions) time.Duration

type JobOptions

+ Backoff BackoffFunc

+ type OnceJobOptions struct

+ Backoff BackoffFunc

+ DequeueMiddleware []DequeueMiddleware

+ HandleMiddleware []HandleMiddleware

+ MaxExecutionTime time.Duration

+ func (opt *OnceJobOptions) AddDequeueMiddleware(mw DequeueMiddleware) *OnceJobOptions

+ func (opt *OnceJobOptions) AddHandleMiddleware(mw HandleMiddleware) *OnceJobOptions

+ func (opt *OnceJobOptions) Validate() error

type Worker

+ func (w *Worker) RunOnce(ctx context.Context, queueID string, h ContextHandleFunc, opt *OnceJobOptions) error

Apr 3, 2021

Changes in this version

+ type ExternalBulkEnqueuer interface

+ ExternalBulkEnqueue func([]*Job, *EnqueueOptions) error

+ type ExternalEnqueuer interface

+ ExternalEnqueue func(*Job, *EnqueueOptions) error

Nov 19, 2020

Changes in this version

+ var ErrDoNotRetry = errors.New("work: do not retry")

+ type BulkJobFinder interface

+ BulkFind func(jobIDs []string, opts *FindOptions) ([]*Job, error)

+ type ContextHandleFunc func(context.Context, *Job, *DequeueOptions) error

+ type FindOptions struct

+ Namespace string

+ func (opt *FindOptions) Validate() error

type Worker

+ func (w *Worker) RegisterWithContext(queueID string, h ContextHandleFunc, opt *JobOptions) error

Oct 21, 2020

Changes in this version

+ type InvalidJobPayloadError struct

+ Err error

+ func (e *InvalidJobPayloadError) Error() string

type WorkerOptions

+ ErrorFunc func(error)

Sep 9, 2019

Changes in this version

+ var ErrAt = errors.New("work: at should not be zero")

+ var ErrEmptyNamespace = errors.New("work: empty namespace")

+ var ErrEmptyQueue = errors.New("work: no job is found")

+ var ErrEmptyQueueID = errors.New("work: empty queue id")

+ var ErrIdleWait = errors.New("work: idle wait should be > 0")

+ var ErrInvisibleSec = errors.New("work: invisible sec should be >= 0")

+ var ErrMaxExecutionTime = errors.New("work: max execution time should be > 0")

+ var ErrNumGoroutines = errors.New("work: number of goroutines should be > 0")

+ var ErrQueueNotFound = errors.New("work: queue is not found")

+ var ErrUnrecoverable = errors.New("work: permanent error")

+ var ErrUnsupported = errors.New("work: unsupported")

+ type AckOptions struct

+ Namespace string

+ QueueID string

+ func (opt *AckOptions) Validate() error

+ type BulkDequeuer interface

+ BulkAck func([]*Job, *AckOptions) error

+ BulkDequeue func(int64, *DequeueOptions) ([]*Job, error)

+ type BulkEnqueuer interface

+ BulkEnqueue func([]*Job, *EnqueueOptions) error

+ type DequeueFunc func(*DequeueOptions) (*Job, error)

+ type DequeueMiddleware func(DequeueFunc) DequeueFunc

+ type DequeueOptions struct

+ At time.Time

+ InvisibleSec int64

+ Namespace string

+ QueueID string

+ func (opt *DequeueOptions) Validate() error

+ type Dequeuer interface

+ Ack func(*Job, *AckOptions) error

+ Dequeue func(*DequeueOptions) (*Job, error)

+ type EnqueueFunc func(*Job, *EnqueueOptions) error

+ type EnqueueMiddleware func(EnqueueFunc) EnqueueFunc

+ type EnqueueOptions struct

+ Namespace string

+ QueueID string

+ func (opt *EnqueueOptions) Validate() error

+ type Enqueuer interface

+ Enqueue func(*Job, *EnqueueOptions) error

+ type HandleFunc func(*Job, *DequeueOptions) error

+ type HandleMiddleware func(HandleFunc) HandleFunc

+ type Job struct

+ CreatedAt time.Time

+ EnqueuedAt time.Time

+ ID string

+ LastError string

+ Payload []byte

+ Retries int64

+ UpdatedAt time.Time

+ func NewJob() *Job

+ func (j *Job) MarshalJSONPayload(v interface{}) error

+ func (j *Job) MarshalPayload(v interface{}) error

+ func (j *Job) UnmarshalJSONPayload(v interface{}) error

+ func (j *Job) UnmarshalPayload(v interface{}) error

+ func (j Job) Delay(d time.Duration) *Job

+ func (j Job) WithPayload(v interface{}) (*Job, error)

+ type JobOptions struct

+ DequeueMiddleware []DequeueMiddleware

+ HandleMiddleware []HandleMiddleware

+ IdleWait time.Duration

+ MaxExecutionTime time.Duration

+ NumGoroutines int64

+ func (opt *JobOptions) AddDequeueMiddleware(mw DequeueMiddleware) *JobOptions

+ func (opt *JobOptions) AddHandleMiddleware(mw HandleMiddleware) *JobOptions

+ func (opt *JobOptions) Validate() error

+ type Metrics struct

+ Queue []*QueueMetrics

+ type MetricsExporter interface

+ GetQueueMetrics func(*QueueMetricsOptions) (*QueueMetrics, error)

+ type Queue interface

+ func NewRedisQueue(client *redis.Client) Queue

+ type QueueMetrics struct

+ Namespace string

+ QueueID string

+ ReadyTotal int64

+ ScheduledTotal int64

+ type QueueMetricsOptions struct

+ At time.Time

+ Namespace string

+ QueueID string

+ func (opt *QueueMetricsOptions) Validate() error

+ type Worker struct

+ func NewWorker(opt *WorkerOptions) *Worker

+ func (w *Worker) ExportMetrics() (*Metrics, error)

+ func (w *Worker) Register(queueID string, h HandleFunc, opt *JobOptions) error

+ func (w *Worker) Start()

+ func (w *Worker) Stop()

+ type WorkerOptions struct

+ Namespace string

+ Queue Queue