engine

Documentation

Index

• Constants
• func Broker() broker.Broker
• func Datastore() datastore.Datastore
• func RegisterBrokerProvider(name string, provider broker.Provider)
• func RegisterDatastoreProvider(name string, provider datastore.Provider)
• func RegisterEndpoint(method, path string, handler web.HandlerFunc)
• func RegisterJobMiddleware(mw job.MiddlewareFunc)
• func RegisterMounter(runtime, name string, mounter runtime.Mounter)
• func RegisterNodeMiddleware(mw node.MiddlewareFunc)
• func RegisterRuntime(rt runtime.Runtime)
• 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 ...JobListener) (*tork.Job, error)
• func Terminate() error
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Broker() broker.Broker
  • func (e *Engine) Datastore() datastore.Datastore
  • func (e *Engine) RegisterBrokerProvider(name string, provider broker.Provider)
  • func (e *Engine) RegisterDatastoreProvider(name string, provider datastore.Provider)
  • func (e *Engine) RegisterEndpoint(method, path string, handler web.HandlerFunc)
  • func (e *Engine) RegisterJobMiddleware(mw job.MiddlewareFunc)
  • func (e *Engine) RegisterMounter(rt string, name string, mounter runtime.Mounter)
  • func (e *Engine) RegisterNodeMiddleware(mw node.MiddlewareFunc)
  • func (e *Engine) RegisterRuntime(rt runtime.Runtime)
  • 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) State() string
  • func (e *Engine) SubmitJob(ctx context.Context, ij *input.Job, listeners ...JobListener) (*tork.Job, error)
  • func (e *Engine) Terminate() error
• type JobListener
• type Middleware
• type Mode

Constants

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

Functions

func Broker

func Broker() broker.Broker

func Datastore

func Datastore() datastore.Datastore

func RegisterBrokerProvider

func RegisterBrokerProvider(name string, provider broker.Provider)

func RegisterDatastoreProvider

func RegisterDatastoreProvider(name string, provider datastore.Provider)

func RegisterEndpoint

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

func RegisterJobMiddleware

func RegisterJobMiddleware(mw job.MiddlewareFunc)

func RegisterMounter

func RegisterMounter(runtime, name string, mounter runtime.Mounter)

func RegisterNodeMiddleware

func RegisterNodeMiddleware(mw node.MiddlewareFunc)

func RegisterRuntime

func RegisterRuntime(rt runtime.Runtime)

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 ...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) Broker

func (e *Engine) Broker() broker.Broker

Broker returns the broker used by the engine. It is only available after the engine has been started.

func (*Engine) Datastore

func (e *Engine) Datastore() datastore.Datastore

Datastore returns the datastore used by the engine. It is only available after the engine has been started.

func (*Engine) RegisterBrokerProvider

func (e *Engine) RegisterBrokerProvider(name string, provider broker.Provider)

func (*Engine) RegisterDatastoreProvider

func (e *Engine) RegisterDatastoreProvider(name string, provider datastore.Provider)

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

func (e *Engine) RegisterMounter(rt string, name string, mounter runtime.Mounter)

func (*Engine) RegisterNodeMiddleware

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

func (*Engine) RegisterRuntime

func (e *Engine) RegisterRuntime(rt runtime.Runtime)

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

func (e *Engine) State() string

func (*Engine) SubmitJob

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

func (*Engine) Terminate

func (e *Engine) Terminate() error

type JobListener

type JobListener func(j *tork.Job)

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