interrupt

README

interrupt

Handle shutdowns cleanly and enable hot reload

Documentation

Index

• Variables
• func AddHandler(handler func())
• func GoroutineDump() string
• func Listener()
• func Request()
• func RequestRestart()
• func Requested() bool
• func Restart()
• type B
• type Ctx
• type E
• type HandlerWithSource
• type N
• type S

Variables

var (
	RestartRequested bool // = true

	// ShutdownRequestChan is a channel that can receive shutdown requests
	ShutdownRequestChan = qu.T()

	// HandlersDone is closed after all interrupt handlers run the first time an interrupt is
	// signaled.
	HandlersDone = make(qu.C)
)

Functions

func AddHandler

func AddHandler(handler func())

AddHandler adds a handler to call when a SIGINT (Ctrl+C) is received.

func GoroutineDump

func GoroutineDump() string

GoroutineDump returns a string with the current goroutine dump in order to show what's going on in case of timeout.

func Listener

func Listener()

Listener listens for interrupt signals, registers interrupt callbacks, and responds to custom shutdown signals as required

func Request

func Request()

Request programmatically requests a shutdown

func RequestRestart

func RequestRestart()

RequestRestart sets the reset flag and requests a restart

func Requested

func Requested() bool

Requested returns true if an interrupt has been requested

func Restart

func Restart()

Types

type B

type B = []byte

type Ctx

type Ctx = context.T

type E

type E = error

type HandlerWithSource

type HandlerWithSource struct {
	Source string
	Fn     func()
}

type N

type N = int

type S

type S = string