Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

guex

package module

Go to main page

Versions in this module

v0

v0.2.1

Nov 6, 2023

v0.2.0

Apr 26, 2023

Changes in this version

+ var ErrDiscard = errors.New("error discard")

type ErrJobReschedule

+ RescheduleJobAt func() time.Time

v0.1.3

Apr 24, 2023

v0.1.2

Apr 24, 2023

Changes in this version

type WorkerPoolOption

+ func WithBackoff(backoff Backoff) WorkerPoolOption

v0.1.1

Apr 24, 2023

Changes in this version

type WorkerPool

+ func (w *WorkerPool) Client() *Client

v0.1.0

Apr 24, 2023

Changes in this version

+ const WorkerIdxUnknown

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

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

+ var EnqueueMeter instrument.Int64Counter

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

+ var Meter = global.MeterProvider().Meter("guex")

+ 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

+ type Backoff func(job *Job, retries int) time.Duration

+ func NewConstantBackoff(d time.Duration) Backoff

+ func NewExponentialBackoff(cfg exp.Config) Backoff

+ type Client struct

+ func NewClient(pool *pgxpool.Pool, options ...ClientOption) (c *Client)

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

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

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

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

+ func (c *Client) LockNextScheduledJob(ctx context.Context, limits []QueueLimit) (jobs []*Job, err error)

+ func (c *Client) RestoreStuck(ctx context.Context, runAfter time.Duration, queue ...QueueLimit) (err error)

+ type ClientOption func(*Client)

+ func WithClientBackoff(backoff Backoff) ClientOption

+ type ErrJobReschedule interface

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

+ type Job struct

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

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

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

+ type PollStrategy string

+ type QueueLimit struct

+ Limit int32

+ Queue string

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

+ type WorkMap map[string]WorkFunc

+ type WorkerPool struct

+ func NewWorkerPool(c *Client, options ...WorkerPoolOption) (*WorkerPool, error)

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

+ func (w *WorkerPool) Stop()

+ func (w *WorkerPool) WorkMap(wm WorkMap)

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

+ type WorkerPoolOption func(pool *WorkerPool)

+ func WithLogger(l *zap.Logger) WorkerPoolOption

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

+ func WithPoolHooksJobDone(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolHooksUnknownJobType(hooks ...HookFunc) WorkerPoolOption

+ func WithPoolID(id string) WorkerPoolOption

+ func WithPoolInterval(d time.Duration) WorkerPoolOption

+ func WithPoolPanicStackBufSize(size int) WorkerPoolOption

+ func WithPoolQueueRestore(restoreAfter, interval time.Duration) WorkerPoolOption

+ func WithWorkerPanicStackBufSize(size int) WorkerPoolOption

+ func WithWorkerPanicWorkerMap(workMap WorkMap) WorkerPoolOption

+ func WithWorkerPoolHandler(jobType string, h WorkFunc) WorkerPoolOption

+ func WithWorkerPoolQueue(queue ...QueueLimit) WorkerPoolOption