clifecycle

Documentation

Overview

Package clifecycle provides a Copper app's lifecycle management. It allows hooks to be registered that are run during various checkpoints in the app's lifecycle.

Index

• type Lifecycle
  • func New() *Lifecycle
  • func (lc *Lifecycle) OnStop(fn func(ctx context.Context) error)
  • func (lc *Lifecycle) Stop(logger Logger)
• type Logger

Types

type Lifecycle

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

Lifecycle represents the lifecycle of an app. Most importantly, it allows various parts of the app to register stop funcs that are run before the app exits. Packages such as chttp use Lifecycle to gracefully stop the HTTP server before the app exits.

func New

func New() *Lifecycle

New instantiates and returns a new Lifecycle that can be used with New to create a Copper app.

func (*Lifecycle) OnStop

func (lc *Lifecycle) OnStop(fn func(ctx context.Context) error)

OnStop registers the provided fn to run before the app exits. The fn is given a context with a deadline. Once the deadline expires, the app may exit forcefully.

func (*Lifecycle) Stop

func (lc *Lifecycle) Stop(logger Logger)

Stop runs all of the registered stop funcs in order along with a context with a configured timeout.

type Logger

type Logger interface {
	Error(msg string, err error)
}

Logger provides the methods needed by Lifecycle to log errors.