signals

Documentation

Overview

Package signals provides a signal handler which is usable as a cmdutil.Server.

Index

• func NewServer(logger logrus.FieldLogger, signals ...os.Signal) cmdutil.Server
• func WithNotifyCancel(ctx context.Context, signals ...os.Signal) context.Context

Functions

func NewServer

func NewServer(logger logrus.FieldLogger, signals ...os.Signal) cmdutil.Server

NewServer returns a cmdutil.Server that returns from Run when any of the provided signals are received. Run always returns a nil error.

func WithNotifyCancel

func WithNotifyCancel(ctx context.Context, signals ...os.Signal) context.Context

WithNotifyCancel creates a sub-context from the given context which gets canceled upon receiving any of the configured signals.