termination

Documentation

Overview

Package termination contains a simple handler for termination signals.

It is wired into system.System by default.

Index

• Variables
• func Handle(ctx context.Context, delay time.Duration) error

Variables

var ErrTerminated = o11y.NewWarning("terminated")

ErrTerminated is used to indicate that the Handle func received a shutdown signal.

Functions

func Handle

func Handle(ctx context.Context, delay time.Duration) error

Handle is intended to be used with a x/sync/errgroup.WithContext group. When a signal is received Handle returns ErrTerminated. If the context is cancelled Handle will return with no error.