plumber

Documentation

Index

• Variables
• func GenerateMessageDescriptors(cliOpts *opts.CLIOptions) (map[pb.MDType]*desc.MessageDescriptor, error)
• type Config
• type Plumber
  • func New(cfg *Config) (*Plumber, error)
  • func (p *Plumber) HandleBatchCmd() error
  • func (p *Plumber) HandleDynamicCmd() error
  • func (p *Plumber) HandleReadCmd() error
  • func (p *Plumber) HandleRelayCmd() error
  • func (p *Plumber) HandleWriteCmd() error
  • func (p *Plumber) Run()
  • func (p *Plumber) RunServer() error

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("CLIOptions cannot be nil")
)

Functions

func GenerateMessageDescriptors

func GenerateMessageDescriptors(cliOpts *opts.CLIOptions) (map[pb.MDType]*desc.MessageDescriptor, error)

Types

type Config

type Config struct {
	PersistentConfig   *config.Config
	ServiceShutdownCtx context.Context
	MainShutdownFunc   context.CancelFunc
	MainShutdownCtx    context.Context
	CLIOptions         *opts.CLIOptions
	KongCtx            *kong.Context
}

Config contains configurable options for instantiating a new Plumber

type Plumber

type Plumber struct {
	*Config

	Etcd    *etcd.Etcd
	RelayCh chan interface{}
	// contains filtered or unexported fields
}

func New

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

New instantiates a properly configured instance of Plumber or a config error

func (*Plumber) HandleBatchCmd

func (p *Plumber) HandleBatchCmd() error

HandleBatchCmd handles all commands related to Batch.sh API

func (*Plumber) HandleDynamicCmd

func (p *Plumber) HandleDynamicCmd() error

HandleDynamicCmd handles dynamic replay destination mode commands

func (*Plumber) HandleReadCmd

func (p *Plumber) HandleReadCmd() error

HandleReadCmd handles CLI read mode

func (*Plumber) HandleRelayCmd

func (p *Plumber) HandleRelayCmd() error

HandleRelayCmd handles CLI relay mode. Container/envar mode is handled by processEnvRelayFlags

func (*Plumber) HandleWriteCmd

func (p *Plumber) HandleWriteCmd() error

HandleWriteCmd handles write mode

func (*Plumber) Run

func (p *Plumber) Run()

Run is the main entrypoint to the plumber application

func (*Plumber) RunServer

func (p *Plumber) RunServer() error

RunServer is a wrapper for starting embedded etcd and starting the gRPC server.