termhook

Documentation

Index

• func Add(callback func())
• func AddWithSignal(callback SignalCallback)
• type SignalCallback

Examples

• Add
• AddWithSignal

Functions

func Add

func Add(callback func())

Add enqueues a simple func() callback to run when the app is terminated.

Example

signalCaught := newAtomicBool()

Add(func() {
	signalCaught.set(true)
})
simulateSignal()

fmt.Printf("Signal Caught: %t", signalCaught.get())

Output:

Signal Caught: true

func AddWithSignal

func AddWithSignal(callback SignalCallback)

AddWithSignal enqueues a callback that will be run when the app is terminated.

Example

signalCaught := newAtomicBool()

AddWithSignal(func(sig os.Signal) {
	signalCaught.set(true)
})
simulateSignal()

fmt.Printf("Signal Caught: %t", signalCaught.get())

Output:

Signal Caught: true

Types

type SignalCallback

type SignalCallback func(os.Signal)

SignalCallback is a callback for handling os signals.