lifecycle

Documentation

Index

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

Variables

var ErrNotStarted = orberrors.NewTransient(errors.New("service has not started"))

ErrNotStarted indicates that an attempt was made to invoke a service that has not been started or is still in the process of starting.

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() 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.

type State

type State = uint32

State is the state of the service.

const (
	// StateNotStarted indicates that the service has not been started.
	StateNotStarted State = 0
	// StateStarting indicates that the service is in the process of starting.
	StateStarting State = 1
	// StateStarted indicates that the service has been started.
	StateStarted State = 2
	// StateStopped indicates that the service has been stopped.
	StateStopped State = 3
)