runtime

Documentation

Overview

Package runtime contains code suitable for deployer implementers but not MX application developers.

Index

• Constants
• func CheckMXNArgs(w *protos.MXNArgs) error
• func DataDir() (string, error)
• func LogsDir() string
• func NewTempDir() (string, error)
• func OnExitSignal(fn func())
• func ParseConfig(file string, input string, sectionValidator func(string, string) error) (*protos.AppConfig, error)
• func ParseConfigSection(key, shortKey string, sections map[string]string, dst any) error
• type Bootstrap
  • func GetBootstrap(ctx context.Context) (Bootstrap, error)
  • func (b Bootstrap) Exists() bool

Constants

const (
	// MXNArgsKey is the environment variable that holds the base64 encoded
	// protos.MXNArgs message for a mxn started by an envelope. For internal
	// use by MX infrastructure.
	MXNArgsKey = "MXN_ARGS"
)

const Main = "github.com/sh3lk/mx/Main"

Main is the name of the main component.

Functions

func CheckMXNArgs

func CheckMXNArgs(w *protos.MXNArgs) error

CheckMXNArgs checks that MXNArgs is well-formed.

func DataDir

func DataDir() (string, error)

DataDir returns the default directory for MX deployer data. The returned directory is $XDG_DATA_HOME/mx, or ~/.local/share/mx if XDG_DATA_HOME is not set.

We recommend that deployers store their data in a directory within this default directory. For example, the "mx multi" deployer stores its data in "DataDir()/multi".

func LogsDir

func LogsDir() string

LogsDir returns the default directory for MX logs, $DIR/tmp/mx/logs where $DIR is the default directory used for temporary files (see os.TempDir for details). We recommend that deployers store their logs in a directory within this default directory. For example, on Unix systems, the "mx multi" deployer stores its data in /tmp/mx/logs/multi.

func NewTempDir

func NewTempDir() (string, error)

NewTempDir returns a new directory, e.g., to hold Unix domain sockets for internal communication. The new directory is not accessible by other users. Caller is responsible for cleaning up the directory when not needed.

func OnExitSignal

func OnExitSignal(fn func())

OnExitSignal arranges to run fn() when a signal that might cause the process to exit is delivered.

func ParseConfig

func ParseConfig(file string, input string, sectionValidator func(string, string) error) (*protos.AppConfig, error)

ParseConfig parses the specified configuration input, which should hold a set of sections in TOML format from the specified file. The section corresponding to the common MX application configuration is parsed and returned as a *AppConfig.

sectionValidator(key, val) is used to validate every section config entry.

func ParseConfigSection

func ParseConfigSection(key, shortKey string, sections map[string]string, dst any) error

ParseConfigSection parses the config section for key into dst. If shortKey is not empty, either key or shortKey is accepted. If the named section is not found, returns nil without changing dst.

Types

type Bootstrap

type Bootstrap struct {
	Args *protos.MXNArgs
}

Bootstrap holds configuration information used to start a process execution.

func GetBootstrap

func GetBootstrap(ctx context.Context) (Bootstrap, error)

GetBootstrap returns information needed to configure process execution. For normal execution, this comes from the environment. For mxtest, it comes from a context value.

func (Bootstrap) Exists

func (b Bootstrap) Exists() bool

Exists returns true if bootstrap information has been supplied. This is true except in the case of singleprocess.