utils

Documentation

Index

• Variables
• func OnDone(ctx context.Context, cb func(error))
• func WithSignal(ctx context.Context, sig ...os.Signal) (context.Context, context.CancelFunc)

Variables

var (
	// DefaultTerminateSignals default signals to handle
	// if not signals are provided
	// NOTE: we use the default st here instead of ALL signals
	// to avoid dying on signals like SIGCHLD and others that
	// are not intend to terminate the process
	DefaultTerminateSignals = []os.Signal{
		syscall.SIGTERM, syscall.SIGHUP, syscall.SIGINT,
		syscall.SIGQUIT,
	}
)

Functions

func OnDone

func OnDone(ctx context.Context, cb func(error))

OnDone registers a callback on a context when it's done The ctx.Err() is passed as is to the callback function

func WithSignal

func WithSignal(ctx context.Context, sig ...os.Signal) (context.Context, context.CancelFunc)

WithSignal return a context that is canceld if any of the specified signals was received