shutdown

Documentation

Index

• Constants
• Variables
• func AddHook(fn shutdownHook)
• func AddHookWithPriority(label string, priority int, fn shutdownHook)
• func ShutdownAndExit(code int, msg string)
• func WaitForSignal()
• type ShutdownTask
• type ShutdownTasks
  • func (st ShutdownTasks) Len() int
  • func (st ShutdownTasks) Less(i, j int) bool
  • func (st *ShutdownTasks) Pop() interface{}
  • func (st *ShutdownTasks) Push(x interface{})
  • func (st ShutdownTasks) Swap(i, j int)

Constants

const (
	PriorityIngress  = 100
	PriorityJobs     = 500
	PriorityCritical = 1000
)

Some helper priority levels

Variables

var Shutdown = sync.OnceFunc(func() {
	logger.Infof("begin shutdown")

	for len(shutdownTaskRegistry) > 0 {
		_task := heap.Pop(&shutdownTaskRegistry)
		if _task == nil {
			break
		}

		task := _task.(ShutdownTask)
		logger.Infof("shutting down: %s", task.Label)

		s := time.Now()
		task.Hook()
		logger.Infof("shutdown %s completed in %v", task.Label, time.Since(s))
	}
})

Functions

func AddHook

func AddHook(fn shutdownHook)

Add a hook with the least priority. Least priority hooks are run first.

Prefer AddHookWithPriority()

func AddHookWithPriority

func AddHookWithPriority(label string, priority int, fn shutdownHook)

AddHookWithPriority adds a hook with a priority level.

Execution order goes from lowest to highest priority numbers.

func ShutdownAndExit

func ShutdownAndExit(code int, msg string)

func WaitForSignal

func WaitForSignal()

Types

type ShutdownTask

type ShutdownTask struct {
	Hook     shutdownHook
	Label    string
	Priority int
}

type ShutdownTasks

type ShutdownTasks []ShutdownTask

ShutdownTasks implements heap.Interface

func (ShutdownTasks) Len

func (st ShutdownTasks) Len() int

func (ShutdownTasks) Less

func (st ShutdownTasks) Less(i, j int) bool

func (*ShutdownTasks) Pop

func (st *ShutdownTasks) Pop() interface{}

func (*ShutdownTasks) Push

func (st *ShutdownTasks) Push(x interface{})

func (ShutdownTasks) Swap

func (st ShutdownTasks) Swap(i, j int)