graceful

package

v1.0.3 Latest Latest Go to latest Published: Dec 29, 2022 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

Repository

github.com/egnd/go-helpers

Documentation ¶

Overview ¶

Package graceful has tools for making graceful shutdown.

Index ¶

Variables
func Init(ctx context.Context, signals ...os.Signal) (context.Context, context.CancelFunc)
func Register(funcs ...Callback) error
func Wait() error
type Callback

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCallbackCnt = errors.New("invalid callbacks count, required only start and stop callbacks") //nolint:revive
	ErrStartFunc   = errors.New("invalid start func")                                              //nolint:revive
	ErrStopFunc    = errors.New("invalid stop func")                                               //nolint:revive
)

Functions ¶

func Init ¶

func Init(ctx context.Context, signals ...os.Signal) (context.Context, context.CancelFunc)

Init subscribes to os signals and registers cancel func and group context.

func Register ¶

func Register(funcs ...Callback) error

Register registers some service to listen and its "stop" function.

func Wait ¶

func Wait() error

Wait registers executor for "stop" callbacks and blocks until all registered callbacks will end.

Types ¶

type Callback ¶

type Callback func() error

Callback is a common function type.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL