engine

package

v0.1.72 Latest Latest Go to latest Published: Apr 15, 2024 License: MIT Imports: 33 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/runabol/tork

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func OnBrokerInit(fn func(b mq.Broker) error)
func RegisterBrokerProvider(name string, provider mq.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) OnBrokerInit(fn func(b mq.Broker) error)
- func (e *Engine) RegisterBrokerProvider(name string, provider mq.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 ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

func OnBrokerInit ¶ added in v0.1.55

func OnBrokerInit(fn func(b mq.Broker) error)

func RegisterBrokerProvider ¶ added in v0.1.16

func RegisterBrokerProvider(name string, provider mq.Provider)

func RegisterDatastoreProvider ¶ added in v0.1.16

func RegisterDatastoreProvider(name string, provider datastore.Provider)

func RegisterEndpoint ¶ added in v0.1.8

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

func RegisterJobMiddleware ¶ added in v0.1.8

func RegisterJobMiddleware(mw job.MiddlewareFunc)

func RegisterMounter ¶ added in v0.1.16

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

func RegisterNodeMiddleware ¶ added in v0.1.8

func RegisterNodeMiddleware(mw node.MiddlewareFunc)

func RegisterRuntime ¶ added in v0.1.19

func RegisterRuntime(rt runtime.Runtime)

func RegisterTaskMiddleware ¶ added in v0.1.8

func RegisterTaskMiddleware(mw task.MiddlewareFunc)

func RegisterWebMiddleware ¶ added in v0.1.8

func RegisterWebMiddleware(mw web.MiddlewareFunc)

func Run ¶ added in v0.1.8

func Run() error

func SetMode ¶ added in v0.1.8

func SetMode(mode Mode)

func Start ¶ added in v0.1.8

func Start() error

func SubmitJob ¶ added in v0.1.8

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

func Terminate ¶ added in v0.1.8

func Terminate() error

Types ¶

type Config ¶ added in v0.1.8

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) OnBrokerInit ¶ added in v0.1.55

func (e *Engine) OnBrokerInit(fn func(b mq.Broker) error)

func (*Engine) RegisterBrokerProvider ¶ added in v0.1.16

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

func (*Engine) RegisterDatastoreProvider ¶ added in v0.1.16

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 ¶ added in v0.1.3

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

func (*Engine) RegisterMounter ¶ added in v0.1.16

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

func (*Engine) RegisterNodeMiddleware ¶ added in v0.1.3

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

func (*Engine) RegisterRuntime ¶ added in v0.1.19

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

func (*Engine) RegisterTaskMiddleware ¶ added in v0.1.3

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

func (*Engine) RegisterWebMiddleware ¶ added in v0.1.8

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

func (*Engine) Run ¶ added in v0.1.8

func (e *Engine) Run() error

func (*Engine) SetMode ¶ added in v0.1.8

func (e *Engine) SetMode(mode Mode)

func (*Engine) Start ¶

func (e *Engine) Start() error

func (*Engine) State ¶ added in v0.1.13

func (e *Engine) State() string

func (*Engine) SubmitJob ¶ added in v0.1.8

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 ¶ added in v0.1.67

type JobListener func(j *tork.Job)

type Middleware ¶ added in v0.1.8

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL