shutdown

Documentation

Index

• Variables
• func Inhibit()
• func Register(name string, handler func(os.Signal) error) error
• func SetExitCode(i int)
• func Start() error
• func Stop() error
• func Uninhibit()

Variables

var (
	ErrHandlerExists = errors.New("handler with given name already exists")
)

var (
	ErrNotStarted = errors.New("shutdown signal handler has not yet been started")
)

Functions

func Inhibit

func Inhibit()

Inhibit temporarily inhibit signals from shutting down Libpod.

func Register

func Register(name string, handler func(os.Signal) error) error

Register registers a function that will be executed when Podman is terminated by a signal. Handlers are invoked LIFO - the last handler registered is the first run.

func SetExitCode

func SetExitCode(i int)

SetExitCode when we exit after we ran all shutdown handlers, it should be positive.

func Start

func Start() error

Start begins handling SIGTERM and SIGINT and will run the given on-signal handlers when one is called and then exit with the exit code of 1 if not overwritten with SetExitCode(). This can be cancelled by calling Stop().

func Stop

func Stop() error

Stop the shutdown signal handler.

func Uninhibit

func Uninhibit()

Uninhibit stop inhibiting signals from shutting down Libpod.