fake

Documentation

Index

• type Engine
  • func NewEngine() *Engine
  • func (e *Engine) RegisterJob(name string, fn async.JobFn) error
  • func (e *Engine) Run(ctx context.Context) error
  • func (e *Engine) SubmitTask(task async.Task) error
• type RunFn

Types

type Engine

type Engine struct {
	SubmittedTasks map[string]async.Task
	RunBehavior    RunFn
}

Engine is a fake implementation of async.Engine used for testing

func NewEngine

func NewEngine() *Engine

NewEngine returns a new, fake implementation of async.Engine used for testing

func (*Engine) RegisterJob

func (e *Engine) RegisterJob(name string, fn async.JobFn) error

RegisterJob registers a new Job with the async engine

func (*Engine) Run

func (e *Engine) Run(ctx context.Context) error

Run causes the async engine to carry out all of its functions. It blocks until a fatal error is encountered or the context passed to it has been canceled. Run always returns a non-nil error.

func (*Engine) SubmitTask

func (e *Engine) SubmitTask(task async.Task) error

SubmitTask submits an idempotent task to the async engine for reliable, asynchronous completion

type RunFn

type RunFn func(context.Context) error

RunFn describes a function used to provide pluggable runtime behavior to the fake async engine