atexit

package

v1.66.0 Latest Latest Go to latest Published: Mar 10, 2024 License: MIT Imports: 7 Imported by: 30

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

Package atexit provides handling for functions you want called when the program exits unexpectedly due to a signal.

You should also make sure you call Run in the normal exit path.

This section is empty.

This section is empty.

func IgnoreSignals()

IgnoreSignals disables the signal handler and prevents Run from being executed automatically

func OnError(perr *error, fn func()) func()

OnError registers fn with atexit and returns a function which runs fn() if *perr != nil and deregisters fn

It should be used in a defer statement normally so

defer OnError(&err, cancelFunc)()

So cancelFunc will be run if the function exits with an error or at exit.

cancelFunc will only be run once.

func Run()

Run all the at exit functions if they haven't been run already

func Signalled() bool

Signalled returns true if an exit signal has been received

func Unregister(handle FnHandle)

Unregister a function using the handle returned by `Register`

type FnHandle *func()

FnHandle is the type of the handle returned by function `Register` that can be used to unregister an at-exit function

func Register(fn func()) FnHandle

Register a function to be called on exit. Returns a handle which can be used to unregister the function with `Unregister`.