graceful

package

v0.0.0-...-4b9205a Latest Latest Go to latest Published: Mar 21, 2023 License: MIT Imports: 8 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

This section is empty.

This section is empty.

This section is empty.

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

Graceful struct to hold the provided options and dependencies

func New() *Graceful

New initiate graceful using context background.

func NewContext(ctx context.Context, signals ...os.Signal) *Graceful

NewContext initiate graceful with context param. create signal waiting from os signal that will be triggered when some signal is called.

func (g *Graceful) RegisterProcess(process func() error)

RegisterProcess register running process to background.

func (g *Graceful) RegisterShutdownProcess(process func(context.Context) error)

RegisterShutdownProcess register shutdown process that will be called when got some os signal.

func (g *Graceful) RegisterShutdownProcessWithTag(process func(context.Context) error, tag string)

RegisterShutdownProcessWithTag register shutdown process using tag.

func (g *Graceful) SetCancelOnError(value bool)

SetCancelOnError set cancel on error value.

func (g *Graceful) SetMaxShutdownProcess(max int)

SetMaxShutdownProcess set max shutdown process value.

func (g *Graceful) SetMaxShutdownTime(duration time.Duration)

SetMaxShutdownTime set max shutdown time value.

func (g *Graceful) Wait() error

Wait waiting for os signal send and call shutdown process when got some signal.