shutdown

package

v0.2.0 Latest Latest Go to latest Published: May 15, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package shutdown provides graceful shutdown handling for applications.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Timeout time.Duration
	Signals []os.Signal
}

Config configures shutdown behavior.

func DefaultConfig() Config

DefaultConfig returns sensible defaults.

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

Handler manages graceful shutdown.

func New(cfg Config) *Handler

New creates a new shutdown handler.

func (h *Handler) Listen() context.Context

Listen starts listening for shutdown signals. Returns a context that will be cancelled on shutdown.

func (h *Handler) Register(fn func(ctx context.Context) error)

Register adds a shutdown hook.

func (h *Handler) Trigger()

Trigger manually triggers shutdown.

func (h *Handler) Wait()

Wait blocks until shutdown is complete.