listeners

Documentation

Index

• func Exists(name string) messages.UserMessage
• func GetListenerByName(name string) (messages.UserMessage, uuid.UUID)
• func GetListenerConfiguredOptions(listenerID uuid.UUID) (messages.UserMessage, map[string]string)
• func GetListenerNamesCompleter() func(string) []string
• func GetListenerOptions(protocol string) map[string]string
• func GetListenerOptionsCompleter(protocol string) func(string) []string
• func GetListenerStatus(listenerID uuid.UUID) messages.UserMessage
• func GetListenerTypes() []string
• func GetListenerTypesCompleter() func(string) []string
• func GetListeners() []listeners.Listener
• func NewListener(options map[string]string) (messages.UserMessage, uuid.UUID)
• func Remove(name string) messages.UserMessage
• func Restart(listenerID uuid.UUID) messages.UserMessage
• func SetOption(listenerID uuid.UUID, Args []string) messages.UserMessage
• func Start(name string) messages.UserMessage
• func Stop(name string) messages.UserMessage

Functions

func Exists

func Exists(name string) messages.UserMessage

Exists determines if the input listener name is an instantiated object

func GetListenerByName

func GetListenerByName(name string) (messages.UserMessage, uuid.UUID)

GetListenerByName return the unique identifier for an instantiated Listener by its name

func GetListenerConfiguredOptions

func GetListenerConfiguredOptions(listenerID uuid.UUID) (messages.UserMessage, map[string]string)

GetListenerConfiguredOptions enumerates all of a Listener's settings and returns them

func GetListenerNamesCompleter

func GetListenerNamesCompleter() func(string) []string

GetListenerNamesCompleter returns CLI tab completer for available Listeners

func GetListenerOptions

func GetListenerOptions(protocol string) map[string]string

GetListenerOptions returns all of the configurable options for an uninstatiated listener based on the provided protocol type

func GetListenerOptionsCompleter

func GetListenerOptionsCompleter(protocol string) func(string) []string

GetListenerOptionsCompleter returns CLI tab completer for supported Listener server protocols

func GetListenerStatus

func GetListenerStatus(listenerID uuid.UUID) messages.UserMessage

GetListenerStatus returns the Listener's server status

func GetListenerTypes

func GetListenerTypes() []string

GetListenerTypes returns the supported server protocols that are available to be used with a Listener

func GetListenerTypesCompleter

func GetListenerTypesCompleter() func(string) []string

GetListenerTypesCompleter returns CLI tab completer for available Listener types

func GetListeners

func GetListeners() []listeners.Listener

GetListeners returns a list of an instantiated Listeners

func NewListener

func NewListener(options map[string]string) (messages.UserMessage, uuid.UUID)

NewListener instantiates a new Listener object on the server

func Remove

func Remove(name string) messages.UserMessage

Remove deletes and removes the listener from the server

func Restart

func Restart(listenerID uuid.UUID) messages.UserMessage

Restart restarts the Listener's server

func SetOption

func SetOption(listenerID uuid.UUID, Args []string) messages.UserMessage

SetOption sets the value of a configurable Listener option

func Start

func Start(name string) messages.UserMessage

Start runs the Listener's server

func Stop

func Stop(name string) messages.UserMessage

Stop terminates the Listener's server