shutdown

Documentation

Overview

Package shutdown provides a mechanism for registering handlers to be called on process shutdown.

Index

• Constants
• func Handle(onShutdown func())
• func Now(code int)

Constants

const GracePeriod = 1 * time.Minute

GracePeriod specifies the maximum amount of time during which all shutdown handlers must complete before the process forcibly exits.

Functions

func Handle

func Handle(onShutdown func())

Handle registers the onShutdown function to be run when the system is being shut down. On shutdown, registered functions are run in last-in-first-out order. Handle may be called concurrently.

func Now

func Now(code int)

Now calls all registered shutdown closures in last-in-first-out order and terminates the process with the given status code. It only executes once and guarantees termination within GracePeriod. Now may be called concurrently.