graceful

Documentation

Index

• func Graceful(ctx context.Context, handlers ...Handler) (err error)
• type Handler
• type ShutdownFunc
• type StartFunc

Functions

func Graceful

func Graceful(ctx context.Context, handlers ...Handler) (err error)

Graceful sets up graceful handling of context done, typically for an HTTP server. When context is done, the shutdown handler will be invoked with a context. Example:

ctx is wrapped WithShutdownSignal(ctx)
When signal is trapped, the shutdown handler will be invoked with a context.

Types

type Handler

type Handler struct {
	Name         string       // server name
	StartFunc    StartFunc    // func to start the server
	ShutdownFunc ShutdownFunc // func to shutdown the server
}

type ShutdownFunc

type ShutdownFunc func(context.Context) error

ShutdownFunc is the type of the function invoked by Graceful to shutdown the server

type StartFunc

type StartFunc func(context.Context) error

StarFunc is the type of the function invoked by Graceful to start the server