signal2

Documentation

Index

• Constants
• func SetupSignalHandler() (stopCh <-chan struct{})
• type SignalTrap
  • func Termination() SignalTrap
  • func (trap SignalTrap) Wait(ctx context.Context) error

Constants

const ErrSignalTrapped = "signal trapped"

ErrSignalTrapped is returned by the SignalTrap.Wait when the expected signals caught.

Functions

func SetupSignalHandler

func SetupSignalHandler() (stopCh <-chan struct{})

SetupSignalHandler registered for SIGTERM and SIGINT. A stop channel is returned which is closed on one of these signals. If a second signal is caught, the program is terminated with exit code 1.

Types

type SignalTrap

type SignalTrap chan os.Signal

SignalTrap wraps os.Signal channel to provide high level API above it.

trap := make(chan os.Signal)
signal.Notify(trap, os.Interrupt)
SignalTrap(trap).Wait(context.Background())

func Termination

func Termination() SignalTrap

Termination returns trap for termination signals.

server := new(http.Server)
go log.Println(server.ListenAndServe())

err := sync.Termination().Wait(context.Background())
if err == sync.ErrSignalTrapped {
	log.Println("shutting down the server", server.Shutdown(context.Background()))
}

func (SignalTrap) Wait

func (trap SignalTrap) Wait(ctx context.Context) error

Wait blocks until one of the expected signals caught or the Context closed. It unregisters from the notification and closes itself.