sigcontext

Documentation

Index

• func WithSignalCancel(ctx context.Context, sigs ...os.Signal) (context.Context, context.CancelFunc)

Functions

func WithSignalCancel

func WithSignalCancel(ctx context.Context, sigs ...os.Signal) (context.Context, context.CancelFunc)

WithSignalCancel is a context that will cancel itself when a signal is sent to the process. The cancel function returned is responsible for freeing the signal handlers used and must be called. If a caller wants to default the signal handlers to the go runtime then the cancel must be called as soon as the derived context is Done() (ie: a second ^C, SIGINT, will cause the process to terminate).