lifecycle

Documentation

Index

• type Hook
• type HookRecord
• type HookRecords
  • func (rs HookRecords) Format(w fmt.State, c rune)
  • func (rs HookRecords) Len() int
  • func (rs HookRecords) Less(i, j int) bool
  • func (rs HookRecords) String() string
  • func (rs HookRecords) Swap(i, j int)
• type Lifecycle
  • func New(logger fxevent.Logger, clock fxclock.Clock) *Lifecycle
  • func (l *Lifecycle) Append(hook Hook)
  • func (l *Lifecycle) RunningHookCaller() string
  • func (l *Lifecycle) Start(ctx context.Context) error
  • func (l *Lifecycle) StartHookRecords() HookRecords
  • func (l *Lifecycle) Stop(ctx context.Context) error
  • func (l *Lifecycle) StopHookRecords() HookRecords

Types

type Hook

type Hook struct {
	OnStart func(context.Context) error
	OnStop  func(context.Context) error
	// contains filtered or unexported fields
}

A Hook is a pair of start and stop callbacks, either of which can be nil, plus a string identifying the supplier of the hook.

type HookRecord

type HookRecord struct {
	CallerFrame fxreflect.Frame             // stack frame of the caller
	Func        func(context.Context) error // function that ran as sanitized name
	Runtime     time.Duration               // how long the hook ran
}

HookRecord keeps track of each Hook's execution time, the caller that appended the Hook, and function that ran as the Hook.

type HookRecords

type HookRecords []HookRecord

HookRecords is a Stringer wrapper of HookRecord slice.

func (HookRecords) Format

func (rs HookRecords) Format(w fmt.State, c rune)

Format implements fmt.Formatter to handle "%+v".

func (HookRecords) Len

func (rs HookRecords) Len() int

func (HookRecords) Less

func (rs HookRecords) Less(i, j int) bool

func (HookRecords) String

func (rs HookRecords) String() string

Used for logging startup errors.

func (HookRecords) Swap

func (rs HookRecords) Swap(i, j int)

type Lifecycle

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

Lifecycle coordinates application lifecycle hooks.

func New

func New(logger fxevent.Logger, clock fxclock.Clock) *Lifecycle

New constructs a new Lifecycle.

func (*Lifecycle) Append

func (l *Lifecycle) Append(hook Hook)

Append adds a Hook to the lifecycle.

func (*Lifecycle) RunningHookCaller

func (l *Lifecycle) RunningHookCaller() string

RunningHookCaller returns the name of the hook that was running when a Start/Stop hook timed out.

func (*Lifecycle) Start

func (l *Lifecycle) Start(ctx context.Context) error

Start runs all OnStart hooks, returning immediately if it encounters an error.

func (*Lifecycle) StartHookRecords

func (l *Lifecycle) StartHookRecords() HookRecords

StartHookRecords returns the info of OnStart hooks that successfully ran till the end, including their caller and runtime. Used to report timeout errors on Start.

func (*Lifecycle) Stop

func (l *Lifecycle) Stop(ctx context.Context) error

Stop runs any OnStop hooks whose OnStart counterpart succeeded. OnStop hooks run in reverse order.

func (*Lifecycle) StopHookRecords

func (l *Lifecycle) StopHookRecords() HookRecords

StopHookRecords returns the info of OnStop hooks that successfully ran till the end, including their caller and runtime. Used to report timeout errors on Stop.