interrupt

Documentation

Index

• Variables
• func AddHandler(handler func())
• func Listener()
• func Request()
• func Requested() bool
• func UseLogger(logger *cl.SubSystem)

Variables

var (

	// InterruptChan is used to receive SIGINT (Ctrl+C) signals.
	InterruptChan chan os.Signal
	// InterruptSignals is the list of signals that cause the interrupt
	InterruptSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}
	// ShutdownRequestChan is a channel that can receive shutdown requests
	ShutdownRequestChan = make(chan struct{})
	// AddHandlerChannel is used to add an interrupt handler to the list of handlers to be invoked on SIGINT (Ctrl+C) signals.
	AddHandlerChannel = make(chan func())
	// HandlersDone is closed after all interrupt handlers run the first time an interrupt is signaled.
	HandlersDone = make(chan struct{})
)

nolint

var Log = cl.NewSubSystem(pkgs.Name(_d), "info")

Functions

func AddHandler

func AddHandler(handler func())

AddHandler adds a handler to call when a SIGINT (Ctrl+C) is received.

func Listener

func Listener()

Listener listens for interrupt signals, registers interrupt callbacks, and responds to custom shutdown signals as required

func Request

func Request()

Request programatically requests a shutdown

func Requested

func Requested() bool

Requested returns true if an interrupt has been requested

func UseLogger

func UseLogger(logger *cl.SubSystem,
)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using log.