natsjobs

Documentation

Index

• type Configurer
• type Consumer
  • func FromConfig(configKey string, log *zap.Logger, cfg Configurer, queue pq.Queue) (*Consumer, error)
  • func FromPipeline(pipe jobs.Pipeline, log *zap.Logger, cfg Configurer, queue pq.Queue) (*Consumer, error)
  • func (c *Consumer) Pause(_ context.Context, p string)
  • func (c *Consumer) Push(_ context.Context, job jobs.Job) error
  • func (c *Consumer) Register(_ context.Context, p jobs.Pipeline) error
  • func (c *Consumer) Resume(_ context.Context, p string)
  • func (c *Consumer) Run(_ context.Context, p jobs.Pipeline) error
  • func (c *Consumer) State(_ context.Context) (*jobs.State, error)
  • func (c *Consumer) Stop(_ context.Context) error
• type Item
  • func (i *Item) Ack() error
  • func (i *Item) Body() []byte
  • func (i *Item) Context() ([]byte, error)
  • func (i *Item) ID() string
  • func (i *Item) Nack() error
  • func (i *Item) Priority() int64
  • func (i *Item) Requeue(headers map[string][]string, _ int64) error
  • func (i *Item) Respond(_ []byte, _ string) error
• type Options
  • func (o *Options) DelayDuration() time.Duration

Types

type Configurer

type Configurer interface {
	// UnmarshalKey takes a single key and unmarshal it into a Struct.
	UnmarshalKey(name string, out any) error

	// Has checks if config section exists.
	Has(name string) bool
}

type Consumer

type Consumer struct {
	// system
	sync.RWMutex
	// contains filtered or unexported fields
}

func FromConfig

func FromConfig(configKey string, log *zap.Logger, cfg Configurer, queue pq.Queue) (*Consumer, error)

func FromPipeline

func FromPipeline(pipe jobs.Pipeline, log *zap.Logger, cfg Configurer, queue pq.Queue) (*Consumer, error)

func (*Consumer) Pause

func (c *Consumer) Pause(_ context.Context, p string)

func (*Consumer) Push

func (c *Consumer) Push(_ context.Context, job jobs.Job) error

func (*Consumer) Register

func (c *Consumer) Register(_ context.Context, p jobs.Pipeline) error

func (*Consumer) Resume

func (c *Consumer) Resume(_ context.Context, p string)

func (*Consumer) Run

func (c *Consumer) Run(_ context.Context, p jobs.Pipeline) error

func (*Consumer) State

func (c *Consumer) State(_ context.Context) (*jobs.State, error)

func (*Consumer) Stop

func (c *Consumer) Stop(_ context.Context) error

type Item

type Item struct {
	// Job contains name of job broker (usually PHP class).
	Job string `json:"job"`

	// Ident is unique identifier of the job, should be provided from outside
	Ident string `json:"id"`

	// Payload is string data (usually JSON) passed to Job broker.
	Payload string `json:"payload"`

	// Headers with key-values pairs
	Headers map[string][]string `json:"headers"`

	// Options contains set of PipelineOptions specific to job execution. Can be empty.
	Options *Options `json:"options,omitempty"`
}

func (*Item) Ack

func (i *Item) Ack() error

func (*Item) Body

func (i *Item) Body() []byte

Body packs job payload into binary payload.

func (*Item) Context

func (i *Item) Context() ([]byte, error)

Context packs job context (job, id) into binary payload.

func (*Item) ID

func (i *Item) ID() string

func (*Item) Nack

func (i *Item) Nack() error

func (*Item) Priority

func (i *Item) Priority() int64

func (*Item) Requeue

func (i *Item) Requeue(headers map[string][]string, _ int64) error

func (*Item) Respond

func (i *Item) Respond(_ []byte, _ string) error

type Options

type Options struct {
	// Priority is job priority, default - 10
	// pointer to distinguish 0 as a priority and nil as priority not set
	Priority int64 `json:"priority"`

	// Pipeline manually specified pipeline.
	Pipeline string `json:"pipeline,omitempty"`

	// Delay defines time duration to delay execution for. Defaults to none.
	Delay int64 `json:"delay,omitempty"`

	// AutoAck option
	AutoAck bool `json:"auto_ack"`
	// contains filtered or unexported fields
}

Options carry information about how to handle given job.

func (*Options) DelayDuration

func (o *Options) DelayDuration() time.Duration

DelayDuration returns delay duration in a form of time.Duration.