signals

Documentation

Index

• func SignalHandlerLoop(log log.Logger, ss ...SignalReceiver)
• type Handler
  • func NewHandler(log log.Logger, receivers ...SignalReceiver) *Handler
  • func (h *Handler) Loop()
  • func (h *Handler) Stop()
• type SignalReceiver

Functions

func SignalHandlerLoop

func SignalHandlerLoop(log log.Logger, ss ...SignalReceiver)

SignalHandlerLoop blocks until it receives a SIGINT, SIGTERM or SIGQUIT. For SIGINT and SIGTERM, it exits; for SIGQUIT is print a goroutine stack dump.

Types

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

Handler handles signals, can be interrupted. On SIGINT or SIGTERM it will exit, on SIGQUIT it will dump goroutine stacks to the Logger.

func NewHandler

func NewHandler(log log.Logger, receivers ...SignalReceiver) *Handler

NewHandler makes a new Handler.

func (*Handler) Loop

func (h *Handler) Loop()

Loop handles signals.

func (*Handler) Stop

func (h *Handler) Stop()

Stop the handler

type SignalReceiver

type SignalReceiver interface {
	Stop() error
}

SignalReceiver represents a subsystem/server/... that can be stopped or queried about the status with a signal