engine

Documentation

Index

• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) OnStarted(h OnStartedHandler)
  • func (e *Engine) Start() error
  • func (e *Engine) Terminate()
• type Middleware
• type Mode
• type OnStartedHandler

Types

type Config

type Config struct {
	Mode       Mode
	Middleware Middleware
	Endpoints  map[string]web.HandlerFunc
}

type Engine

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

func New

func New(cfg Config) *Engine

func (*Engine) OnStarted

func (e *Engine) OnStarted(h OnStartedHandler)

func (*Engine) Start

func (e *Engine) Start() error

func (*Engine) Terminate

func (e *Engine) Terminate()

type Middleware

type Middleware struct {
	Web  []web.MiddlewareFunc
	Task []task.MiddlewareFunc
	Job  []job.MiddlewareFunc
	Node []node.MiddlewareFunc
}

type Mode

type Mode string

const (
	ModeCoordinator Mode = "coordinator"
	ModeWorker      Mode = "worker"
	ModeStandalone  Mode = "standalone"
)

type OnStartedHandler

type OnStartedHandler func() error

OnStartedHandler a bootstrap hook that is called after Tork has finished starting up. If a non-nil error is returned it will terminate the bootstrap process.