shutdown

Documentation

Overview

Package shutdown contains data and methods to support safe shutdown.

Index

• func RoutineDone(id ShutdownId)
• func Shutdown()
• func ShutdownOnSigint()
• type ShutdownId
  • func AddShutdownListener(routineName string) (ShutdownId, chan bool)

Functions

func RoutineDone

func RoutineDone(id ShutdownId)

Marks that a routine has finished shutdown

func Shutdown

func Shutdown()

Requests shutdown, and waits until shutdown has completed

func ShutdownOnSigint

func ShutdownOnSigint()

Blocks and requests shutdown on receiving SIGINT, unblocks on completion of shutdown.

Types

type ShutdownId

type ShutdownId uint64

A unique ID to represent a process' shutdown listener request.

func AddShutdownListener

func AddShutdownListener(routineName string) (ShutdownId, chan bool)

Records that a module will be waiting for shutdown. Returns A channel to listen for shutdown requests.