runtime

Documentation

Index

• type Builder
  • func NewBuilder(dir string, bin string, wd string, buildArgs []string) Builder
• type Config
  • func LoadConfig(path string) (*Config, error)
• type Proxy
  • func NewProxy(builder Builder, runner Runner) Proxy
• type Runner
  • func NewRunner(bin string, args ...string) Runner

Types

type Builder

type Builder interface {
	// Build creates the temporal executable
	Build() error
	// Binary returns the reference to the runtime binary
	Binary() string
	// Errors returns any errors from the executable
	Errors() string
}

Builder provides a binary builder

func NewBuilder

func NewBuilder(dir string, bin string, wd string, buildArgs []string) Builder

New constructs a new Builder

type Config

type Config struct {
	Laddr    string `json:"laddr"`
	Port     int    `json:"port"`
	ProxyTo  string `json:"proxy_to"`
	KeyFile  string `json:"key_file"`
	CertFile string `json:"cert_file"`
}

func LoadConfig

func LoadConfig(path string) (*Config, error)

type Proxy

type Proxy interface {
	// Run bootstraps the web service proxy
	Run(config *Config) error
	io.Closer
}

Proxy provides a web server proxy

func NewProxy

func NewProxy(builder Builder, runner Runner) Proxy

NewProxy constructs a new Proxy

type Runner

type Runner interface {
	// Run executes the temporal binary
	Run() (*exec.Cmd, error)
	// Info provides file metadata about the runtime executable
	Info() (os.FileInfo, error)
	// SetWriter provides an output sink for the runtime
	SetWriter(io.Writer)
	// Kill terminates the executable
	Kill() error
}

Runner provides the executable runtime

func NewRunner

func NewRunner(bin string, args ...string) Runner

NewRunner constructs a new runtime