runtime

Documentation

Overview

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

Index

• Constants
• func CheckEnvelopeInfo(w *protos.EnvelopeInfo) error
• func DataDir() (string, error)
• func LogsDir() string
• 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) HasPipes() bool
  • func (b Bootstrap) MakePipes() (io.ReadCloser, io.WriteCloser, error)
• type BootstrapKey

Constants

const (
	// ToWeaveletKey is the environment variable under which the file descriptor
	// for messages sent from envelope to weavelet is stored. For internal use by
	// Service Weaver infrastructure.
	ToWeaveletKey = "ENVELOPE_TO_WEAVELET_FD"

	// ToEnvelopeKey is the environment variable under which the file descriptor
	// for messages sent from weavelet to envelope is stored. For internal use by
	// Service Weaver infrastructure.
	ToEnvelopeKey = "WEAVELET_TO_ENVELOPE_FD"
)

const Main = "github.com/ServiceWeaver/weaver/Main"

Main is the name of the main component.

Functions

func CheckEnvelopeInfo

func CheckEnvelopeInfo(w *protos.EnvelopeInfo) error

CheckEnvelopeInfo checks that EnvelopeInfo is well-formed.

func DataDir

func DataDir() (string, error)

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

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

func LogsDir

func LogsDir() string

LogsDir returns the default directory for Service Weaver logs, $DIR/tmp/serviceweaver/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 "weaver multi" deployer stores its data in /tmp/serviceweaver/logs/multi.

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 Service Weaver 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 {
	ToWeaveletFd   uintptr  // File descriptor on which to send to weavelet (0 if unset)
	ToEnvelopeFd   uintptr  // File descriptor from which to send to envelope (0 if unset)
	ToWeaveletFile *os.File // Pipe to send to weavelet (weavertest only).
	ToEnvelopeFile *os.File // Pipe to send to envelope (weavertest only).
	TestConfig     string   // Config file contents (weavertest only).
	Quiet          bool     // Don't log or print anything.
}

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 weavertest, it comes from a context value.

func (Bootstrap) HasPipes

func (b Bootstrap) HasPipes() bool

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

func (Bootstrap) MakePipes

func (b Bootstrap) MakePipes() (io.ReadCloser, io.WriteCloser, error)

MakePipes creates pipe reader and writer. It returns an error if pipes are not configured.

type BootstrapKey

type BootstrapKey struct{}

BootstrapKey is the Context key used by weavertest to pass Bootstrap to [weaver.Run].