signal

package

v1.1.0 Latest Latest Go to latest Published: Jan 29, 2026 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aretw0/lifecycle

Links

Open Source Insights

Documentation ¶

Overview ¶

Package signal provides a stateful signal context for interactive CLI applications.

Unlike the standard signal.NotifyContext which cancels on the first signal, this package distinguishes between SIGINT (soft interrupt) and SIGTERM (hard stop).

This allows applications to implement patterns like "Press Ctrl+C again to exit" or to prompt for confirmation before shutting down.

Index ¶

type Context
- func NewContext(parent context.Context, opts ...Option) *Context
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Context ¶

type Context struct {
	context.Context
	Cancel func()
	// contains filtered or unexported fields
}

Context wraps a context and captures the signal that cancelled it.

func NewContext ¶

func NewContext(parent context.Context, opts ...Option) *Context

NewContext creates a context that is cancelled on SIGTERM or SIGINT (standard termination). On the first signal received, it cancels the context to initiate graceful shutdown (if configured). If a second signal is received before the program exits, it performs an immediate os.Exit(1) (if configured).

func (*Context) OnShutdown ¶ added in v1.1.0

func (sc *Context) OnShutdown(f func())

OnShutdown registers a function to be called when the context receives a shutdown signal. Hooks are executed in LIFO (Last-In-First-Out) order, simulating `defer`. Execution happens asynchronously after the context is cancelled. Call Wait() to block until all hooks (including those registered dynamically) have finished.

func (*Context) Signal ¶

func (sc *Context) Signal() os.Signal

Signal returns the signal that caused the context to be cancelled/interrupted, or nil.

func (*Context) Stop ¶ added in v1.1.0

func (sc *Context) Stop()

Stop stops the signal monitoring and restores default behavior. It also ensures Wait() unblocks if called.

func (*Context) Wait ¶ added in v1.1.0

func (sc *Context) Wait()

Wait blocks until all registered hooks have completed execution. This is essential to prevent the main function from exiting before cleanup is done.

type Option ¶ added in v1.1.0

type Option func(*options)

Option is a functional option for configuring signal behavior.

func WithForceExit ¶ added in v1.1.0

func WithForceExit(threshold int) Option

WithForceExit configures the threshold of signals required to trigger an immediate os.Exit(1). Set to 0 to disable forced exit. Default is 2.

func WithHookTimeout ¶ added in v1.1.0

func WithHookTimeout(d time.Duration) Option

WithHookTimeout configures the duration after which a running hook produces a warning log. Default is 5 seconds.

func WithInterrupt ¶ added in v1.1.0

func WithInterrupt(cancel bool) Option

WithInterrupt configures whether SIGINT (Ctrl+C) should cancel the context. Default is true.

Source Files ¶

View all Source files

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