engine

Documentation

Index

• Constants
• func RegisterEndpoint(method, path string, handler web.HandlerFunc)
• func RegisterJobMiddleware(mw job.MiddlewareFunc)
• func RegisterNodeMiddleware(mw node.MiddlewareFunc)
• func RegisterTaskMiddleware(mw task.MiddlewareFunc)
• func RegisterWebMiddleware(mw web.MiddlewareFunc)
• func Run() error
• func SetMode(mode Mode)
• func Start() error
• func SubmitJob(ctx context.Context, ij *input.Job, listeners ...web.JobListener) (*tork.Job, error)
• func Terminate() error
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) RegisterEndpoint(method, path string, handler web.HandlerFunc)
  • func (e *Engine) RegisterJobMiddleware(mw job.MiddlewareFunc)
  • func (e *Engine) RegisterNodeMiddleware(mw node.MiddlewareFunc)
  • func (e *Engine) RegisterTaskMiddleware(mw task.MiddlewareFunc)
  • func (e *Engine) RegisterWebMiddleware(mw web.MiddlewareFunc)
  • func (e *Engine) Run() error
  • func (e *Engine) SetMode(mode Mode)
  • func (e *Engine) Start() error
  • func (e *Engine) SubmitJob(ctx context.Context, ij *input.Job, listeners ...web.JobListener) (*tork.Job, error)
  • func (e *Engine) Terminate() error
• type Middleware
• type Mode
• type OnStartedHandler

Constants

const (
	StateIdle        = "IDLE"
	StateRunning     = "RUNNING"
	StateTerminating = "TERMINATING"
	StateTerminated  = "TERMINATED"
)

Functions

func RegisterEndpoint

func RegisterEndpoint(method, path string, handler web.HandlerFunc)

func RegisterJobMiddleware

func RegisterJobMiddleware(mw job.MiddlewareFunc)

func RegisterNodeMiddleware

func RegisterNodeMiddleware(mw node.MiddlewareFunc)

func RegisterTaskMiddleware

func RegisterTaskMiddleware(mw task.MiddlewareFunc)

func RegisterWebMiddleware

func RegisterWebMiddleware(mw web.MiddlewareFunc)

func Run

func Run() error

func SetMode

func SetMode(mode Mode)

func Start

func Start() error

func SubmitJob

func SubmitJob(ctx context.Context, ij *input.Job, listeners ...web.JobListener) (*tork.Job, error)

func Terminate

func Terminate() error

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) RegisterEndpoint

func (e *Engine) RegisterEndpoint(method, path string, handler web.HandlerFunc)

func (*Engine) RegisterJobMiddleware

func (e *Engine) RegisterJobMiddleware(mw job.MiddlewareFunc)

func (*Engine) RegisterNodeMiddleware

func (e *Engine) RegisterNodeMiddleware(mw node.MiddlewareFunc)

func (*Engine) RegisterTaskMiddleware

func (e *Engine) RegisterTaskMiddleware(mw task.MiddlewareFunc)

func (*Engine) RegisterWebMiddleware

func (e *Engine) RegisterWebMiddleware(mw web.MiddlewareFunc)

func (*Engine) Run

func (e *Engine) Run() error

func (*Engine) SetMode

func (e *Engine) SetMode(mode Mode)

func (*Engine) Start

func (e *Engine) Start() error

func (*Engine) SubmitJob

func (e *Engine) SubmitJob(ctx context.Context, ij *input.Job, listeners ...web.JobListener) (*tork.Job, error)

func (*Engine) Terminate

func (e *Engine) Terminate() error

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.