controller

Documentation

Index

• Constants
• func ShutdownListenerOnPort(port int) error
• type CommandInfo
• type CommandKey
  • func ResolveCommandKeyString(key string) (CommandKey, error)
• type CommandOption
  • func ResolveCommandOptionString(key string) (CommandOption, error)
• type CommandServer
  • func SetupNewListenerOnPort(port int) (*CommandServer, error)
  • func (server *CommandServer) ShutdownListener()
  • func (server *CommandServer) StartListener() (err error)
  • func (server *CommandServer) StartListenerInBackground() (err error)
  • func (server *CommandServer) String() string
• type CommandTarget
  • func ResolveCommandTargetString(key string) (CommandTarget, error)
• type ControlCommand

Constants

const (
	CommandStart    CommandKey = "start"
	CommandShutdown            = "shutdown"
	CommandAdd                 = "add"
	CommandRemove              = "remove"
	CommandList                = "list"
)

const (
	CommandTargetMonitor   CommandTarget = "monitor"
	CommandTargetEmail                   = "email"
	CommandTargetLocations               = "locations"
	CommandTargetSites                   = "sites"
)

const (
	CommandOptionConfig            CommandOption = "config"
	CommandOptionPort                            = "port"
	CommandOptionTo                              = "to"
	CommandOptionFrom                            = "from"
	CommandOptionFor                             = "for"
	CommandOptionLocation                        = "location"
	CommandOptionSites                           = "sites"
	CommandOptionHighPrioritySites               = "hpsites"
)

Functions

func ShutdownListenerOnPort

func ShutdownListenerOnPort(port int) error

Types

type CommandInfo

type CommandInfo struct {
	Command    CommandKey
	ConfigFile string
}

type CommandKey

type CommandKey string

func ResolveCommandKeyString

func ResolveCommandKeyString(key string) (CommandKey, error)

type CommandOption

type CommandOption string

func ResolveCommandOptionString

func ResolveCommandOptionString(key string) (CommandOption, error)

type CommandServer

type CommandServer struct {
	Port    int
	Timeout time.Time
	// contains filtered or unexported fields
}

func SetupNewListenerOnPort

func SetupNewListenerOnPort(port int) (*CommandServer, error)

func (*CommandServer) ShutdownListener

func (server *CommandServer) ShutdownListener()

func (*CommandServer) StartListener

func (server *CommandServer) StartListener() (err error)

func (*CommandServer) StartListenerInBackground

func (server *CommandServer) StartListenerInBackground() (err error)

func (*CommandServer) String

func (server *CommandServer) String() string

type CommandTarget

type CommandTarget string

func ResolveCommandTargetString

func ResolveCommandTargetString(key string) (CommandTarget, error)

type ControlCommand

type ControlCommand struct {
	Command     CommandKey
	Target      CommandTarget
	Options     map[CommandOption]string
	TargetValue string
}