lifecycle

Documentation

Index

• type Lifecycle
  • func New(name string, opts ...Opt) *Lifecycle
  • func (h *Lifecycle) Start()
  • func (h *Lifecycle) State() spi.State
  • func (h *Lifecycle) Stop()
• type Opt
  • func WithStart(start func()) Opt
  • func WithStop(stop func()) Opt

Types

type Lifecycle

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

Lifecycle implements the lifecycle of a service, i.e. Start and Stop.

func New

func New(name string, opts ...Opt) *Lifecycle

New returns a new Lifecycle.

func (*Lifecycle) Start

func (h *Lifecycle) Start()

Start starts the service.

func (*Lifecycle) State

func (h *Lifecycle) State() spi.State

State returns the state of the service.

func (*Lifecycle) Stop

func (h *Lifecycle) Stop()

Stop stops the service.

type Opt

type Opt func(opts *options)

Opt sets a Lifecycle option.

func WithStart

func WithStart(start func()) Opt

WithStart sets the start function which is invoked when Start() is called.

func WithStop

func WithStop(stop func()) Opt

WithStop sets the stop function which is invoked when Stop() is called.