signalx

package

v1.1.0 Latest Latest Go to latest Published: Jan 5, 2023 License: MIT Imports: 8 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

This section is empty.

This section is empty.

func Contains(signals []os.Signal, signal os.Signal) bool

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

ContextWithSignal creates a new context that cancels on the given signals.

func IsSignal(err error, signals []os.Signal) bool

func IsSignalError(err error) bool

func ShutdownSignals() []os.Signal

func SignalContext(signals ...os.Signal) (context.Context, context.CancelFunc)

SignalContext creates a new context that cancels on the given signals.

type SignalError struct {
	Signal os.Signal
}

func (e SignalError) Error() string

type SignalHook = map[os.Signal]func()

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

func NewSignalWaiter(signals []os.Signal, waitTimeout time.Duration, hooks ...func(os.Signal)) *SignalWaiter

func (w *SignalWaiter) Err() error

func (w *SignalWaiter) Signal() os.Signal

func (w *SignalWaiter) Wait() *SignalWaiter