jobs

type Broker interface {
	// Listen configures broker with list of pipelines to listen and handler function.
	Listen(pipelines []*Pipeline, pool chan Handler, err ErrorHandler) error

	// Serve broker must listen for all associated pipelines and consume given jobs.
	Serve() error

	// Stop must stop broker.
	Stop()

	// Push new job to the broker. Must return job id or error.
	Push(p *Pipeline, j *Job) (id string, err error)
}

type Config struct {
	// Workers configures roadrunner server and worker busy.
	Workers *roadrunner.ServerConfig

	// Pipelines defines mapping between PHP job pipeline and associated job broker.
	Pipelines []*Pipeline
}

type ErrorHandler func(id string, j *Job, err error) error

type Handler func(id string, j *Job) error

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

	// Attempt is number of job attempt if case of error.
	Attempt int `json:"attempt"`

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

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

type Options struct {
	// Delay defines time duration to delay execution for. Defaults to none.
	Delay int `json:"delay,omitempty"`

	// RetryDelay defines for how long job should be waiting until next retry. Defaults to none.
	RetryDelay int `json:"retryDelay,omitempty"`

	// Reserve defines for how broker should wait until treating job are failed. Defaults to 30 min.
	Timeout int `json:"timeout,omitempty"`

	// Maximum job retries. Defaults to none.
	MaxAttempts int `json:"maxAttempts,omitempty"`
}

type Pipeline struct {
	// Broker defines name of associated broker.
	Broker string

	// Listen define job matching pattern (i.e. - "app.jobs.email")
	Handle []string

	// Retry defined number of job retries in case of error. Default none.
	Retry int

	// RetryDelay defines for how long wait till job retry.
	RetryDelay int

	// Listen tells the service that this pipeline must be consumed by the service.
	Listen bool

	// Options are broker specific PipelineOptions.
	Options PipelineOptions
}

type PipelineOptions map[string]interface{}

type Service struct {
	// Brokers define list of available brokers.
	Brokers map[string]Broker
	// contains filtered or unexported fields
}