plumber

Documentation

Index

• Variables
• type Config
• type Plumber
  • func New(cfg *Config) (*Plumber, error)
  • func (p *Plumber) Run()

Variables

var (
	ErrMissingShutdownCtx      = errors.New("ServiceShutdownCtx cannot be nil")
	ErrMissingMainShutdownFunc = errors.New("MainShutdownFunc cannot be nil")
	ErrMissingMainContext      = errors.New("MainContext cannot be nil")
	ErrMissingOptions          = errors.New("Options cannot be nil")
)

Types

type Config

type Config struct {
	ServiceShutdownCtx context.Context
	MainShutdownFunc   context.CancelFunc
	MainShutdownCtx    context.Context
	Options            *cli.Options
	Cmd                string
}

Config contains configurable options for instantiating a new Plumber

type Plumber

type Plumber struct {
	*Config
	RelayCh chan interface{}
	MsgDesc *desc.MessageDescriptor
	// contains filtered or unexported fields
}

func New

func New(cfg *Config) (*Plumber, error)

New instantiates a properly configured instance Plumber, or configuration error

func (*Plumber) Run

func (p *Plumber) Run()

Run is the main entrypoint to the plumber application