jobs

Documentation

Index

• Constants
• type Base
  • func NewBase(tasks map[string]Task) Base
  • func (b Base) Next(task string) (next string, ok bool)
  • func (b Base) RunnerFunc(task string) gocelery.RunnerFunc
• type Bootstrapper
  • func (b Bootstrapper) Bootstrap(ctx map[string]interface{}) error
• type Dispatcher
  • func NewDispatcher(db *leveldb.DB, workerCount int, requeueTimeout time.Duration) (Dispatcher, error)
• type Result
• type Task

Constants

const BootstrappedDispatcher = "BootstrappedDispatcher"

BootstrappedDispatcher is a key to access dispatcher

Types

type Base

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

Base can be embeded to implement base interface functions.

func NewBase

func NewBase(tasks map[string]Task) Base

NewBase returns a new base with given tasks

func (Base) Next

func (b Base) Next(task string) (next string, ok bool)

Next returns the next task, if there is any, after the given task

func (Base) RunnerFunc

func (b Base) RunnerFunc(task string) gocelery.RunnerFunc

RunnerFunc returns runner func associated with the task

type Bootstrapper

type Bootstrapper struct{}

Bootstrapper implements bootstrap.Bootstrapper.

func (Bootstrapper) Bootstrap

func (b Bootstrapper) Bootstrap(ctx map[string]interface{}) error

Bootstrap adds transaction.Repository into context.

type Dispatcher

type Dispatcher interface {
	Name() string
	Start(ctx context.Context, wg *sync.WaitGroup, startupErr chan<- error)
	RegisterRunner(name string, runner gocelery.Runner) bool
	RegisterRunnerFunc(name string, runnerFunc gocelery.RunnerFunc) bool
	Dispatch(acc identity.DID, job *gocelery.Job) (Result, error)
	Job(acc identity.DID, jobID gocelery.JobID) (*gocelery.Job, error)
	Result(acc identity.DID, jobID gocelery.JobID) (Result, error)
}

Dispatcher is a task dispatcher

func NewDispatcher

func NewDispatcher(db *leveldb.DB, workerCount int, requeueTimeout time.Duration) (Dispatcher, error)

NewDispatcher returns a new dispatcher with levelDB storage

type Result

type Result interface {
	// Await blocks until job is finished to return its results.
	Await(ctx context.Context) (res interface{}, err error)
}

Result represents a future result of a job

type Task

type Task struct {
	RunnerFunc gocelery.RunnerFunc
	Next       string
}

Task represents a single task and if chained, next task name