Documentation
¶
Index ¶
- type Config
- type Consumer
- func (c *Consumer) Pause(_ context.Context, p string)
- func (c *Consumer) Push(ctx context.Context, jb *jobs.Job) error
- func (c *Consumer) Register(_ context.Context, pipeline *pipeline.Pipeline) error
- func (c *Consumer) Resume(_ context.Context, p string)
- func (c *Consumer) Run(_ context.Context, pipe *pipeline.Pipeline) error
- func (c *Consumer) State(_ context.Context) (*jobs.State, error)
- func (c *Consumer) Stop(_ context.Context) error
- type Item
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Consumer ¶
type Consumer struct {
// contains filtered or unexported fields
}
func FromConfig ¶
func FromConfig(configKey string, log *zap.Logger, cfg config.Configurer, pq priorityqueue.Queue) (*Consumer, error)
func FromPipeline ¶
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"`
}
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"`
// contains filtered or unexported fields
}
Options carry information about how to handle given job.
func (*Options) DelayDuration ¶
DelayDuration returns delay duration in a form of time.Duration.
Click to show internal directories.
Click to hide internal directories.