signal

Documentation

Index

• func Alive() bool
• func DisableLog()
• func Intercept() error
• func Listening() bool
• func RequestShutdown()
• func ShutdownChannel() <-chan struct{}
• func UseLogger(logger btclog.Logger)

Functions

func Alive

func Alive() bool

Alive returns true if the main interrupt handler has not been killed.

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until UseLogger is called.

func Intercept

func Intercept() error

Intercept starts the interception of interrupt signals. Note that this function can only be called once.

func Listening

func Listening() bool

Listening returns true if the main interrupt handler has been started, and has not been killed.

func RequestShutdown

func RequestShutdown()

RequestShutdown initiates a graceful shutdown from the application.

func ShutdownChannel

func ShutdownChannel() <-chan struct{}

ShutdownChannel returns the channel that will be closed once the main interrupt handler has exited.

func UseLogger

func UseLogger(logger btclog.Logger)

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