gue

package module

Go to main page

Versions in this module

v5

v5.6.1

Apr 4, 2024

v5.6.0

Dec 28, 2023

Changes in this version

+ var ErrHookJobDonePanicked = errors.New("hook job done panicked in job panic recovery")

+ var ErrJobPanicked = errors.New("job panicked")

type WorkerOption

+ func WithWorkerHooksJobUndone(hooks ...HookFunc) WorkerOption

+ func WithWorkerUnknownJobWorkFunc(wf WorkFunc) WorkerOption

type WorkerPoolOption

+ func WithPoolHooksJobUndone(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolUnknownJobWorkFunc(wf WorkFunc) WorkerPoolOption

v5.5.0

Aug 31, 2023

Changes in this version

type Job

+ CreatedAt time.Time

v5.4.0

Aug 7, 2023

Changes in this version

type Client

+ func (c *Client) EnqueueWithID(ctx context.Context, j *Job, ulid ulid.ULID) error

v5.3.0

Jul 3, 2023

Changes in this version

type WorkerOption

+ func WithWorkerJobTTL(d time.Duration) WorkerOption

type WorkerPoolOption

+ func WithPoolJobTTL(d time.Duration) WorkerPoolOption

v5.2.1

May 26, 2023

Changes in this version

type WorkerOption

+ func WithWorkerSpanWorkOneNoJob(spanWorkOneNoJob bool) WorkerOption

type WorkerPoolOption

+ func WithPoolSpanWorkOneNoJob(spanWorkOneNoJob bool) WorkerPoolOption

v5.2.0

Apr 28, 2023

Changes in this version

type Client

+ func (c *Client) EnqueueBatch(ctx context.Context, jobs []*Job) error

+ func (c *Client) EnqueueBatchTx(ctx context.Context, jobs []*Job, tx adapter.Tx) error

v5.1.1

Feb 28, 2023

v5.1.0

Feb 26, 2023

v5.0.1

Jan 30, 2023

v5.0.0

Dec 13, 2022

Changes in this version

+ const WorkerIdxUnknown

+ var BackoffNever = func(retries int) time.Duration

+ var DefaultExponentialBackoff = NewExponentialBackoff(exp.Config{ ... })

+ var ErrMissingType = errors.New("job type must be specified")

+ func ErrDiscardJob(reason string) error

+ func ErrRescheduleJobAt(t time.Time, reason string) error

+ func ErrRescheduleJobIn(d time.Duration, reason string) error

+ func GetWorkerIdx(ctx context.Context) int

+ func RandomStringID() string

+ func RunLock(ctx context.Context, f func(ctx context.Context) error, mu *sync.Mutex, ...) error

+ type Backoff func(retries int) time.Duration

+ func NewConstantBackoff(d time.Duration) Backoff

+ func NewExponentialBackoff(cfg exp.Config) Backoff

+ type Client struct

+ func NewClient(pool adapter.ConnPool, options ...ClientOption) (*Client, error)

+ func (c *Client) Enqueue(ctx context.Context, j *Job) error

+ func (c *Client) EnqueueTx(ctx context.Context, j *Job, tx adapter.Tx) error

+ func (c *Client) LockJob(ctx context.Context, queue string) (*Job, error)

+ func (c *Client) LockJobByID(ctx context.Context, id ulid.ULID) (*Job, error)

+ func (c *Client) LockNextScheduledJob(ctx context.Context, queue string) (*Job, error)

+ type ClientOption func(*Client)

+ func WithClientBackoff(backoff Backoff) ClientOption

+ func WithClientID(id string) ClientOption

+ func WithClientLogger(logger adapter.Logger) ClientOption

+ func WithClientMeter(meter metric.Meter) ClientOption

+ type ErrJobReschedule interface

+ type HookFunc func(ctx context.Context, j *Job, err error)

+ type Job struct

+ Args []byte

+ ErrorCount int32

+ ID ulid.ULID

+ LastError sql.NullString

+ Priority JobPriority

+ Queue string

+ RunAt time.Time

+ Type string

+ func (j *Job) Delete(ctx context.Context) error

+ func (j *Job) Done(ctx context.Context) error

+ func (j *Job) Error(ctx context.Context, jErr error) (err error)

+ func (j *Job) Tx() adapter.Tx

+ type JobPriority int16

+ const JobPriorityDefault

+ const JobPriorityHigh

+ const JobPriorityHighest

+ const JobPriorityLow

+ const JobPriorityLowest

+ type PollStrategy string

+ const PriorityPollStrategy

+ const RunAtPollStrategy

+ type WorkFunc func(ctx context.Context, j *Job) error

+ type WorkMap map[string]WorkFunc

+ type Worker struct

+ func NewWorker(c *Client, wm WorkMap, options ...WorkerOption) (*Worker, error)

+ func (w *Worker) Run(ctx context.Context) error

+ func (w *Worker) WorkOne(ctx context.Context) (didWork bool)

+ type WorkerOption func(*Worker)

+ func WithWorkerGracefulShutdown(handlerCtx func() context.Context) WorkerOption

+ func WithWorkerHooksJobDone(hooks ...HookFunc) WorkerOption

+ func WithWorkerHooksJobLocked(hooks ...HookFunc) WorkerOption

+ func WithWorkerHooksUnknownJobType(hooks ...HookFunc) WorkerOption

+ func WithWorkerID(id string) WorkerOption

+ func WithWorkerLogger(logger adapter.Logger) WorkerOption

+ func WithWorkerMeter(meter metric.Meter) WorkerOption

+ func WithWorkerPanicStackBufSize(size int) WorkerOption

+ func WithWorkerPollInterval(d time.Duration) WorkerOption

+ func WithWorkerPollStrategy(s PollStrategy) WorkerOption

+ func WithWorkerQueue(queue string) WorkerOption

+ func WithWorkerTracer(tracer trace.Tracer) WorkerOption

+ type WorkerPool struct

+ func NewWorkerPool(c *Client, wm WorkMap, poolSize int, options ...WorkerPoolOption) (*WorkerPool, error)

+ func (w *WorkerPool) Run(ctx context.Context) error

+ func (w *WorkerPool) WorkOne(ctx context.Context) (didWork bool)

+ type WorkerPoolOption func(pool *WorkerPool)

+ func WithPoolGracefulShutdown(handlerCtx func() context.Context) WorkerPoolOption

+ func WithPoolHooksJobDone(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolHooksJobLocked(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolHooksUnknownJobType(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolID(id string) WorkerPoolOption

+ func WithPoolLogger(logger adapter.Logger) WorkerPoolOption

+ func WithPoolMeter(meter metric.Meter) WorkerPoolOption

+ func WithPoolPanicStackBufSize(size int) WorkerPoolOption

+ func WithPoolPollInterval(d time.Duration) WorkerPoolOption

+ func WithPoolPollStrategy(s PollStrategy) WorkerPoolOption

+ func WithPoolQueue(queue string) WorkerPoolOption

+ func WithPoolTracer(tracer trace.Tracer) WorkerPoolOption

Other modules containing this package

github.com/vgarvardt/gue

github.com/vgarvardt/gue/v2

github.com/vgarvardt/gue/v3

github.com/vgarvardt/gue/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL