halt

Documentation

Overview

Package halt exposes a convenience method to deal with graceful shutdowns.

Index

• type Halter
  • func New(ctx context.Context, log logger.Log) (context.Context, Halter)

Types

type Halter

type Halter interface {
	// Wait should block until a shutdown is requested.
	Wait()
}

Halter will be used to wait for shutdown requests.

func New

func New(ctx context.Context, log logger.Log) (context.Context, Halter)

New configures and returns the context to use when shutting down.