controller

Documentation

Index

• type Controller
  • func NewController(o ...Option) Controller
  • func (c *Controller) Kill(pe process.ProcEntry) error
  • func (c *Controller) List() string
  • func (c *Controller) Shutdown(ch chan struct{}) error
  • func (c *Controller) Start(pe process.ProcEntry) error
• type Option
  • func WithConfig(cfg *config.Config) Option
  • func WithLog(l *zerolog.Logger) Option
• type Options
  • func NewOptions() Options

Types

type Controller

type Controller struct {
	Config *config.Config

	Store storage.Storage

	// Bin is the OCIS single binary name.
	Bin string

	// BinPath is the OCIS single binary path withing the host machine.
	// The Controller needs to know the binary location in order to spawn new extensions.
	BinPath string

	// Terminated facilitates communication from Watcher <-> Controller. Writes to this
	// channel WILL always attempt to restart the crashed process.
	Terminated chan process.ProcEntry
	// contains filtered or unexported fields
}

Controller supervises processes.

func NewController

func NewController(o ...Option) Controller

NewController initializes a new controller.

func (*Controller) Kill

func (c *Controller) Kill(pe process.ProcEntry) error

Kill a managed process. Should a process managed by the runtime be allowed to be killed if the runtime is configured not to?

func (*Controller) List

func (c *Controller) List() string

List managed processes.

func (*Controller) Shutdown

func (c *Controller) Shutdown(ch chan struct{}) error

Shutdown a running runtime.

func (*Controller) Start

func (c *Controller) Start(pe process.ProcEntry) error

Start and watches a process.

type Option

type Option func(o *Options)

Option represents an option.

func WithConfig

func WithConfig(cfg *config.Config) Option

WithConfig sets Controller config.

func WithLog

func WithLog(l *zerolog.Logger) Option

WithLog sets Controller config.

type Options

type Options struct {
	Bin     string
	Restart bool
	Config  *config.Config
	Log     *zerolog.Logger
}

Options are the configurable options for a Controller.

func NewOptions

func NewOptions() Options

NewOptions returns a new Options struct.