README
¶
interrupt
Package interrupt is a single global way to handle process interruption.
It is useful for both long lived process to implement controlled shutdown and for CLI tool to handle early termination.
The interrupt signal can be set exactly once in the process lifetime and cannot be unset. The signal can optionally be set automatically on Ctrl-C/os.Interrupt. When set, it is expected the process to abort any on-going execution early.
The signal can be read via two ways:
select {
case <- interrupt.Channel:
// Handle abort.
case ...
...
default:
}
or
if interrupt.IsSet() {
// Handle abort.
}
Documentation
¶
Overview ¶
Package interrupt is a single global way to handle process interruption.
It is useful for both long lived process to implement controlled shutdown and for CLI tool to handle early termination.
The interrupt signal can be set exactly once in the process lifetime and cannot be unset. The signal can optionally be set automatically on Ctrl-C/os.Interrupt. When set, it is expected the process to abort any on-going execution early.
The signal can be read via two ways:
select {
case <- interrupt.Channel:
// Handle abort.
case ...
...
default:
}
or
if interrupt.IsSet() {
// Handle abort.
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Channel <-chan bool
Channel continuously sends true once the interrupt signal was set. It can be used in select section to handle interrupted process.
var ErrInterrupted = errors.New("interrupted")
ErrInterrupted can be used as an error to signal that a process was interrupted but didn't fail in any other way. This permits disambiguating from any other genuine error.
Functions ¶
func HandleCtrlC ¶
func HandleCtrlC()
HandleCtrlC initializes an handler to handle SIGINT, which is normally sent on Ctrl-C.
This function is provided for convenience. To handle other situations, use Set() directly.
Types ¶
This section is empty.
Source Files