Documentation
¶
Index ¶
Constants ¶
const ( ModeServer = UnderflowMode("server") ModeClient = UnderflowMode("client") )
Values for the UnderflowMode type
Variables ¶
var EnvironmentProviderSet = wire.NewSet( ProvideDebugModeFromEnvironment, ProvideUnderflowListenPortFromEnvironment, ProvideUnderflowMasterAddrFromEnvironment, ProvideUnderflowMinionAddrsFromEnvironment, ProvideUnderflowModeFromEnvironment, )
EnvironmentProviderSet is a Wire provider set for environment configuration
Functions ¶
This section is empty.
Types ¶
type DebugMode ¶
type DebugMode bool
DebugMode is whether a debug state is set
func ProvideDebugModeFromEnvironment ¶
ProvideDebugModeFromEnvironment creates a DebugMode based on the value in the DEBUG env var
type UnderflowListenPort ¶
type UnderflowListenPort int
UnderflowListenPort is the port that a listening Underflow Server uses
func ProvideUnderflowListenPortFromEnvironment ¶
func ProvideUnderflowListenPortFromEnvironment() (UnderflowListenPort, error)
ProvideUnderflowListenPortFromEnvironment creates a UnderflowListenPort from the environment, defaulting to 9876 when missing
type UnderflowMasterAddr ¶
type UnderflowMasterAddr string
UnderflowMasterAddr is the address that a client Underflow connects to
func ProvideUnderflowMasterAddrFromEnvironment ¶
func ProvideUnderflowMasterAddrFromEnvironment() UnderflowMasterAddr
ProvideUnderflowMasterAddrFromEnvironment provides the UnderflowMasterAddr from the environment
type UnderflowMinionAddrs ¶
type UnderflowMinionAddrs []string
UnderflowMinionAddrs is a list of addresses an Underflow master can find its minions at
func ProvideUnderflowMinionAddrsFromEnvironment ¶
func ProvideUnderflowMinionAddrsFromEnvironment() UnderflowMinionAddrs
ProvideUnderflowMinionAddrsFromEnvironment provides the UnderflowMinionAddrs from the environment
type UnderflowMode ¶
type UnderflowMode string
UnderflowMode is the mode that the Underflow process is running in
func ProvideUnderflowModeFromEnvironment ¶
func ProvideUnderflowModeFromEnvironment() (UnderflowMode, error)
ProvideUnderflowModeFromEnvironment provides the UnderflowMode from the environment, erroring when missing
Source Files