cli

package

v1.2.1 Latest Latest Go to latest Published: Jun 30, 2022 License: MIT Imports: 27 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Config(args []string) (config.Config, error)

Config returns CLI configuration

func DebugMode() bool

DebugMode returns true if -debug flag is provided

func PrintHelp()

PrintHelp prints CLI usage instructions to STDOUT

func ShowHelp() bool

ShowHelp returns true if -h flag was provided

func ShowVersion() bool

ShowVersion returns true if -v flag was provided

type Runner struct {
	// contains filtered or unexported fields
}

func NewRunner(name string, config *config.Config) *Runner

func (r *Runner) ControllerFactory(fn controllerFactory)

func (r *Runner) DisconnectorFactory(fn disconnectorFactory)

func (r *Runner) Router() *router.RouterController

func (r *Runner) Run() error

func (r *Runner) SetRouter(router *router.RouterController)

func (r *Runner) SubscriberFactory(fn subscriberFactory)

func (r *Runner) WebsocketHandler(fn websocketHandler)

type Shutdownable interface {
	Shutdown() error
}