shutdown

package module

v0.7.1 Latest Latest Go to latest Published: Sep 16, 2023 License: BSD-3-Clause Imports: 6 Imported by: 1

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

tag release

A simple shutdown watcher with a destructor.

This section is empty.

This section is empty.

This section is empty.

type Destructor func()

type Listener func(chan os.Signal)

type Shutdown struct {
	Destructor Destructor

	*log.Logger
	// contains filtered or unexported fields
}

Shutdown listens for SIGINT and SIGTERM and executes the Destructor

func New(destruct Destructor, signals []syscall.Signal) *Shutdown

New generates a new Shutdown with typical defaults

func (shutdown *Shutdown) Handler(handler http.Handler) http.Handler

wraps any request and checks to make sure that the server isn't shutting down

func (shutdown *Shutdown) IsDown() bool

IsDown checks to see if the shutdown has been triggered

func (shutdown *Shutdown) Now(reason string)

Now allows an application to trigger it's own shutdown

func (shutdown *Shutdown) SetDestructor(destruct Destructor)

func (shutdown *Shutdown) Wait()

Wait is a func that allows the calling context to block until shutdown is finished

Path	Synopsis
example