signal

Documentation

Overview

Package signal implements a handler to listen to system signals.

Index

• Variables
• type Handler
  • func (h *Handler) GracefulStop()
  • func (h *Handler) Name() string
  • func (h *Handler) PreRun(_ context.Context) error
  • func (h *Handler) Serve() run.StopNotify

Variables

var (
	ErrSignal = errors.New("signal received")
)

ErrSignal is returned when a termination signal is received.

Types

type Handler

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

Handler implements a unix signal handler as run.GroupService.

func (*Handler) GracefulStop

func (h *Handler) GracefulStop()

GracefulStop implements run.GroupService and will close the signal handler.

func (*Handler) Name

func (h *Handler) Name() string

Name shows the handler's name.

func (*Handler) PreRun

func (h *Handler) PreRun(_ context.Context) error

PreRun implements run.PreRunner to initialize the handler.

func (*Handler) Serve

func (h *Handler) Serve() run.StopNotify

Serve implements run.Service and listens for incoming unix signals.