machinery

Documentation

Index

• type BaseGear
  • func (bg *BaseGear) Configure(config interface{})
  • func (bg *BaseGear) Name() string
  • func (bg *BaseGear) Provide() interface{}
  • func (bg *BaseGear) SetLogger(logger logger.Logger)
  • func (bg *BaseGear) Shutdown()
  • func (bg *BaseGear) Start(machinery *Machinery)
• type Gear
• type Machinery
  • func NewMachinery() *Machinery
  • func (m *Machinery) GetGear(name string) Gear
  • func (m *Machinery) Shutdown()
  • func (m *Machinery) Start()
  • func (m *Machinery) With(gears ...Gear) *Machinery

Types

type BaseGear

type BaseGear struct {
	Uname  string
	Logger logger.Logger
}

BaseGear .

func (*BaseGear) Configure

func (bg *BaseGear) Configure(config interface{})

Configure default config setter method. It should be overridden in concrete gears to work on config type.

func (*BaseGear) Name

func (bg *BaseGear) Name() string

Name .

func (*BaseGear) Provide

func (bg *BaseGear) Provide() interface{}

Provide is the default do nothing implementation for the Gear interface Provide() func. NOTE that it returns a nil interface{}.

func (*BaseGear) SetLogger

func (bg *BaseGear) SetLogger(logger logger.Logger)

SetLogger default Logger setter method. It should remain not overridden in concrete gears.

func (*BaseGear) Shutdown

func (bg *BaseGear) Shutdown()

Shutdown .

func (*BaseGear) Start

func (bg *BaseGear) Start(machinery *Machinery)

Start is the default do nothing implementation for the Gear interface Start() func.

type Gear

type Gear interface {
	Name() string
	Start(*Machinery)
	Provide() interface{}
	Shutdown()
	SetLogger(logger logger.Logger)
	Configure(config interface{})
}

Gear is the Machinery main building block interface.

type Machinery

type Machinery struct {
	GracefulStop chan os.Signal
	Logger       logger.Logger
	// contains filtered or unexported fields
}

Machinery is the main framework structure.

func NewMachinery

func NewMachinery() *Machinery

NewMachinery initialize and return the main Machinery engine instance.

func (*Machinery) GetGear

func (m *Machinery) GetGear(name string) Gear

GetGear returns a Gear instance pointer

func (*Machinery) Shutdown

func (m *Machinery) Shutdown()

Shutdown all of the registered gears.

func (*Machinery) Start

func (m *Machinery) Start()

Start starts up the Machinery.

func (*Machinery) With

func (m *Machinery) With(gears ...Gear) *Machinery

With register one or more Gears with the Machinery engine.