sigctx

README

Signal Aware Context

This package provides a helper function for Go contexts that get canceled if a specific OS signal is received.

Usage

Import git.prolicht.digital/golib/sigctx. After that you can use the API functions, for example:

ctx := sigctx.New(syscall.SIGHUP)
<-ctx.Done() // this context gets canceled once the SIGHUP signal is received

ctx := sigctx.FromContext(parentCtx, syscall.SIGHUP)
<-ctx.Done() // this context gets canceled once the SIGHUP signal is received or the parent context gets canceled

Documentation

Index

• func FromContext(ctx context.Context, sig ...os.Signal) context.Context
• func New(sig ...os.Signal) context.Context

Functions

func FromContext

func FromContext(ctx context.Context, sig ...os.Signal) context.Context

FromContext returns a context that gets closed once a given signal is retrieved. By default, the following signals are handled: syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP

func New

func New(sig ...os.Signal) context.Context

New returns a context that gets closed once a given signal is retrieved. By default, the following signals are handled: syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP