application

Documentation

Index

• Constants
• type CommandLineFlags
  • func CreateFlags() CommandLineFlags
  • func (flags CommandLineFlags) SetFlagsWithArguments(arguments []string)
• type ListenerSettings
• type Settings
  • func LoadSettings(file string) (settings *Settings, err error)

Constants

const (

	// HostNameFlag is the command-line flag which allows the listen host to be specified
	HostNameFlag = "hostname"
	// PortNameFlag is the command-line flag which allows the listen port to be specified
	PortNameFlag = "port"
	// CertFileFlag is the command-line flag which allows the TLS certificate file is specified
	CertFileFlag = "certFile"
	// KeyFileFlag is the command-line flag which allows the TLS key file to be specified
	KeyFileFlag = "keyFile"
	// TransportProtocolFlag is the command-line flag which allows the TCP transport to be specified
	TransportProtocolFlag = "transport"
	// LogLevelFlag is the command-line flag which allows the log level to be specified
	LogLevelFlag = "logLevel"
)

Types

type CommandLineFlags

type CommandLineFlags map[string]*commandLineFlag

CommandLineFlags contains a map of commandLineFlag structs, indexed by the long flag name

func CreateFlags

func CreateFlags() CommandLineFlags

CreateFlags creates the appropriate struct representing the application command line arguments

func (CommandLineFlags) SetFlagsWithArguments

func (flags CommandLineFlags) SetFlagsWithArguments(arguments []string)

SetFlagsWithArguments sets the value of the flags struct with the actual command-line arguments

type ListenerSettings

type ListenerSettings struct {
	Host      string
	Port      string
	Transport string
	CertFile  string
	KeyFile   string
}

ListenerSettings represents the command-line settings that can additionally be passed

type Settings

type Settings struct {
	Listener ListenerSettings
	Pool     cntrpool.Settings
	Monitor  monitor.Settings
	ECS      cntrmgr.Settings
}

Settings represents the various different parameters that can be configured using an appropriate configuration file

func LoadSettings

func LoadSettings(file string) (settings *Settings, err error)

LoadSettings loads the settings file from the pathname provided. It returns the pointer of a populated Settings struct if this file is valid; a nil pointer and the error that occurred if this is not the case