facile

Documentation

Overview

Package facile exposes a simplified API to core functionality. It's designed to be accessible from another programming language through a foreign function interface.

Index

• type Filesystem
  • func NewFilesystem(root string) (filesystem *Filesystem, err error)
  • func (filesystem *Filesystem) Close() error
• type InstanceImage
  • func NewInstanceImage(prog *ProgramImage, entryFunction string) (*InstanceImage, error)
  • func (inst *InstanceImage) Close() error
• type ProgramImage
  • func NewProgramImage(programStorage *Filesystem, wasm []byte) (*ProgramImage, error)
  • func (prog *ProgramImage) Close() error
• type RuntimeConfig
  • func NewRuntimeConfig() *RuntimeConfig
  • func (c *RuntimeConfig) GetExecDir() string
  • func (c *RuntimeConfig) GetMaxProcs() int32
  • func (c *RuntimeConfig) GetNamespaceDisabled() bool
  • func (c *RuntimeConfig) SetExecDir(s string)
  • func (c *RuntimeConfig) SetMaxProcs(n int32)
  • func (c *RuntimeConfig) SetNamespaceDisabled(b bool)
• type RuntimeContainer
  • func NewRuntimeContainer(binary string, config *RuntimeConfig) (*RuntimeContainer, error)
  • func (x *RuntimeContainer) CloseFD() error
  • func (x *RuntimeContainer) GetFD() int32
• type RuntimeExecutor
  • func NewRuntimeExecutor(config *RuntimeConfig, containerFD int32) (*RuntimeExecutor, error)
  • func (executor *RuntimeExecutor) Close() error
• type RuntimeProcess
  • func NewRuntimeProcess(executor *RuntimeExecutor) (*RuntimeProcess, error)
  • func (process *RuntimeProcess) Kill()
  • func (process *RuntimeProcess) Serve(code *ProgramImage, state *InstanceImage) error
  • func (process *RuntimeProcess) Start(code *ProgramImage, state *InstanceImage) error
  • func (process *RuntimeProcess) Suspend()

Types

type Filesystem

type Filesystem struct {
	// contains filtered or unexported fields
}

func NewFilesystem

func NewFilesystem(root string) (filesystem *Filesystem, err error)

func (*Filesystem) Close

func (filesystem *Filesystem) Close() error

type InstanceImage

type InstanceImage struct {
	// contains filtered or unexported fields
}

func NewInstanceImage

func NewInstanceImage(prog *ProgramImage, entryFunction string) (*InstanceImage, error)

func (*InstanceImage) Close

func (inst *InstanceImage) Close() error

type ProgramImage

type ProgramImage struct {
	// contains filtered or unexported fields
}

func NewProgramImage

func NewProgramImage(programStorage *Filesystem, wasm []byte) (*ProgramImage, error)

func (*ProgramImage) Close

func (prog *ProgramImage) Close() error

type RuntimeConfig

type RuntimeConfig struct {
	// contains filtered or unexported fields
}

func NewRuntimeConfig

func NewRuntimeConfig() *RuntimeConfig

func (*RuntimeConfig) GetExecDir

func (c *RuntimeConfig) GetExecDir() string

func (*RuntimeConfig) GetMaxProcs

func (c *RuntimeConfig) GetMaxProcs() int32

func (*RuntimeConfig) GetNamespaceDisabled

func (c *RuntimeConfig) GetNamespaceDisabled() bool

func (*RuntimeConfig) SetExecDir

func (c *RuntimeConfig) SetExecDir(s string)

func (*RuntimeConfig) SetMaxProcs

func (c *RuntimeConfig) SetMaxProcs(n int32)

func (*RuntimeConfig) SetNamespaceDisabled

func (c *RuntimeConfig) SetNamespaceDisabled(b bool)

type RuntimeContainer

type RuntimeContainer struct {
	// contains filtered or unexported fields
}

func NewRuntimeContainer

func NewRuntimeContainer(binary string, config *RuntimeConfig) (*RuntimeContainer, error)

NewRuntimeContainer.

The MaxProcs config value has no effect here.

func (*RuntimeContainer) CloseFD

func (x *RuntimeContainer) CloseFD() error

func (*RuntimeContainer) GetFD

func (x *RuntimeContainer) GetFD() int32

type RuntimeExecutor

type RuntimeExecutor struct {
	// contains filtered or unexported fields
}

func NewRuntimeExecutor

func NewRuntimeExecutor(config *RuntimeConfig, containerFD int32) (*RuntimeExecutor, error)

NewRuntimeExecutor duplicates the container file descriptor (if any).

func (*RuntimeExecutor) Close

func (executor *RuntimeExecutor) Close() error

type RuntimeProcess

type RuntimeProcess struct {
	// contains filtered or unexported fields
}

func NewRuntimeProcess

func NewRuntimeProcess(executor *RuntimeExecutor) (*RuntimeProcess, error)

func (*RuntimeProcess) Kill

func (process *RuntimeProcess) Kill()

func (*RuntimeProcess) Serve

func (process *RuntimeProcess) Serve(code *ProgramImage, state *InstanceImage) error

func (*RuntimeProcess) Start

func (process *RuntimeProcess) Start(code *ProgramImage, state *InstanceImage) error

func (*RuntimeProcess) Suspend

func (process *RuntimeProcess) Suspend()