graceful

package

v0.0.9 Latest Latest Go to latest Published: Dec 13, 2021 License: MIT Imports: 7 Imported by: 0

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

Package graceful orchestrates shutdown gracefully.

This section is empty.

This section is empty.

This section is empty.

type ErrTimeout []string

ErrTimeout describes tasks that failed to finish in time.

func (e ErrTimeout) Error() string

Error returns an error message.

type Switch struct {
	// contains filtered or unexported fields
}

Switch is graceful shutdown handler.

Please use NewSwitch to create an instance.

func NewSwitch(timeout time.Duration, signals ...os.Signal) *Switch

NewSwitch creates shutdown handler that triggers on any of provided OS signals and allows registered tasks to take up to provided timeout.

When switch is triggered, tasks are invoked concurrently.

func (s *Switch) OnShutdown(name string, fn func())

OnShutdown adds a named task to run on shutdown.

func (s *Switch) Shutdown()

Shutdown triggers the switch and stops listening to OS signals.

func (s *Switch) Wait() <-chan error

Wait returns a channel that blocks until switch is triggered.

Resulting channel may return a non-empty error if tasks fail to finish within a timeout.