cli

Documentation

Index

• func NewConfigFromCLI(args []string, opts ...cliOption) (*config.Config, error, bool)
• func WithCLICustomOptions(factory customOptionsFactory) cliOption
• func WithCLIName(name string) cliOption
• func WithCLIUsageHeader(desc string) cliOption
• func WithCLIVersion(str string) cliOption
• type Option
  • func WithController(fn controllerFactory) Option
  • func WithDefaultRPCController() Option
  • func WithDefaultSubscriber() Option
  • func WithName(name string) Option
  • func WithShutdownable(instance Shutdownable) Option
  • func WithSubscriber(fn subscriberFactory) Option
  • func WithWebSocketEndpoint(path string, fn websocketHandler) Option
  • func WithWebSocketHandler(fn websocketHandler) Option
• type Runner
  • func NewRunner(c *config.Config, options []Option) (*Runner, error)
  • func (r *Runner) Router() *router.RouterController
  • func (r *Runner) Run() error
  • func (r *Runner) SetRouter(router *router.RouterController)
• type Shutdownable

Functions

func NewConfigFromCLI

func NewConfigFromCLI(args []string, opts ...cliOption) (*config.Config, error, bool)

NewConfigFromCLI reads config from os.Args. It returns config, error (if any) and a bool value indicating that the usage message or version was shown, no further action required.

func WithCLICustomOptions

func WithCLICustomOptions(factory customOptionsFactory) cliOption

func WithCLIName

func WithCLIName(name string) cliOption

func WithCLIUsageHeader

func WithCLIUsageHeader(desc string) cliOption

func WithCLIVersion

func WithCLIVersion(str string) cliOption

Types

type Option

type Option func(*Runner) error

Option represents a Runner configuration function

func WithController

func WithController(fn controllerFactory) Option

WithName is an Option to set Runner controller

func WithDefaultRPCController

func WithDefaultRPCController() Option

WithDefaultRPCController is an Option to set Runner controller to default rpc.Controller

func WithDefaultSubscriber

func WithDefaultSubscriber() Option

WithDefaultSubscriber is an Option to set Runner subscriber to pubsub.NewSubscriber

func WithName

func WithName(name string) Option

WithName is an Option to set Runner name

func WithShutdownable

func WithShutdownable(instance Shutdownable) Option

WithShutdowable adds a new shutdownable instance to be shutdown at server stop

func WithSubscriber

func WithSubscriber(fn subscriberFactory) Option

WithSubscriber is an Option to set Runner subscriber

func WithWebSocketEndpoint

func WithWebSocketEndpoint(path string, fn websocketHandler) Option

WithWebSocketEndpoint is an Option to set a custom websocket handler at the specified path

func WithWebSocketHandler

func WithWebSocketHandler(fn websocketHandler) Option

WithWebSocketHandler is an Option to set a custom websocket handler

type Runner

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

func NewRunner

func NewRunner(c *config.Config, options []Option) (*Runner, error)

NewRunner creates returns new Runner structure

func (*Runner) Router

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

func (*Runner) Run

func (r *Runner) Run() error

Run starts the instance

func (*Runner) SetRouter

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

type Shutdownable

type Shutdownable interface {
	Shutdown() error
}