engine

Documentation

Index

• type Callback
• type Engine
  • func New() (engine *Engine)
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) JobAdd(queue string, task Task, callback Callback) (err error)
  • func (e *Engine) QueueAdd(name string, opts *QueueOpts) (err error)
  • func (e *Engine) QueueList()
  • func (e *Engine) Shutdown()
• type QueueOpts
• type Task

Types

type Callback

type Callback interface {
	Send(r io.Reader) (err error)
}

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func New

func New() (engine *Engine)

func (*Engine) Done

func (e *Engine) Done() <-chan struct{}

func (*Engine) JobAdd

func (e *Engine) JobAdd(queue string, task Task, callback Callback) (err error)

JobAdd adds a task to queue. When the task done, its result will be sent.

func (*Engine) QueueAdd

func (e *Engine) QueueAdd(name string, opts *QueueOpts) (err error)

QueueAdd creates a queue in engine with specified name and opts.

func (*Engine) QueueList

func (e *Engine) QueueList()

func (*Engine) Shutdown

func (e *Engine) Shutdown()

Shutdown notify all executors to shutdown.

type QueueOpts

type QueueOpts struct {
	// Consumer count.
	CoreSize int
}

Queue options.

type Task

type Task interface {
	Run(ctx context.Context, cb Callback) error
}