signals

Documentation

Overview

signals is a package for handling signals to gratefully shutdown app in combination with kubernetes pod graceful termination policy.

Index

• func NewSignalChannel() (stopCh <-chan struct{})
• func NewSignalContext() context.Context
• func SetupSignalChannel() (stopCh <-chan struct{})
• func SetupSignalContext() context.Context

Functions

func NewSignalChannel

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

NewSignalChannel 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.

You can call NewSignalChannel() multiple time.

func NewSignalContext

func NewSignalContext() context.Context

NewSignalContext registers for SIGTERM and SIGINT. A context is returned which is canceled on one of these signals. If a second signal is caught, the program is terminated with exit code 1.

You can call NewSignalContext() multiple time.

func SetupSignalChannel

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

SetupSignalChannel 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.

It will panic when call SetupSignalChannel twice.

func SetupSignalContext

func SetupSignalContext() context.Context

SetupSignalContext registers for SIGTERM and SIGINT. A context is returned which is canceled on one of these signals. If a second signal is caught, the program is terminated with exit code 1.

It will panic when call SetupSignalContext twice.