shutdown

Documentation

Index

• Variables
• func Finish()
• func HasFinished() bool
• func Ongoing() bool
• func PerformShutdown(ctx context.Context, cancel context.CancelFunc, server *grpc.Server)
• func Reset()
• func Start()

Variables

var CancelChan chan os.Signal

Channel to receive shutdown signal

var CriticalWaitGroup *sync.WaitGroup

Wait group used in graceful shutdown. Shutdown process will wait for this wait group to be done before canceling the context.

var Finished chan struct{}

It will be closed when the application has finished the shutting down process

var Started chan struct{}

It will be closed when shutdown starts the shutting down process

var WaitGroup *sync.WaitGroup

Wait group used in graceful shutdown. Shutdown will wait for this wait group to be done after canceling the context.

Functions

func Finish

func Finish()

func HasFinished

func HasFinished() bool

It will return true if the application has finished the shutting down process Used in tests

func Ongoing

func Ongoing() bool

It will return true if the application is shutting down or if the application has finished the shutting down process

func PerformShutdown

func PerformShutdown(ctx context.Context, cancel context.CancelFunc, server *grpc.Server)

func Reset

func Reset()

Function used to reset shutdown process for tests

func Start

func Start()