interrupt

Documentation

Overview

+build darwin dragonfly freebsd linux netbsd openbsd solaris

Index

• Variables
• func AddHandler(handler func())
• func Listener()
• func Request()
• func Requested() bool

Variables

var AddHandlerChannel = make(chan func())

AddHandlerChannel is used to add an interrupt handler to the list of handlers to be invoked on SIGINT (Ctrl+C) signals.

var HandlersDone = make(chan struct{})

HandlersDone is closed after all interrupt handlers run the first time an interrupt is signaled.

var InterruptChan chan os.Signal

InterruptChan is used to receive SIGINT (Ctrl+C) signals.

var InterruptSignals = []os.Signal{os.Interrupt, syscall.SIGTERM}

InterruptSignals is the list of signals that cause the interrupt

var ShutdownRequestChan = make(chan struct{})

ShutdownRequestChan is a channel that can receive shutdown requests

Functions

func AddHandler

func AddHandler(
	handler func())

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

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 programatically requests a shutdown

func Requested

func Requested() bool

Requested returns true if an interrupt has been requested