graceful

Documentation

Overview

Package graceful provides an orchestrator for graceful shutdown.

Index

• Constants
• type Shutdown
  • func (s *Shutdown) Close()
  • func (s *Shutdown) EnableGracefulShutdown()
  • func (s *Shutdown) ShutdownSignal(subscriber string) (shutdown <-chan struct{}, done chan<- struct{})
  • func (s *Shutdown) Wait() error
  • func (s *Shutdown) WaitToShutdownHTTP(server *http.Server, subscriber string) error

Constants

const DefaultTimeout = 10 * time.Second

DefaultTimeout is a default Timeout to wait for graceful termination.

Types

type Shutdown

type Shutdown struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

Shutdown manages graceful shutdown.

func (*Shutdown) Close

func (s *Shutdown) Close()

Close invokes shutdown.

func (*Shutdown) EnableGracefulShutdown

func (s *Shutdown) EnableGracefulShutdown()

EnableGracefulShutdown schedules service locator termination SIGTERM or SIGINT.

func (*Shutdown) ShutdownSignal

func (s *Shutdown) ShutdownSignal(subscriber string) (shutdown <-chan struct{}, done chan<- struct{})

ShutdownSignal returns a channel that is closed when service locator is closed or os shutdownSignal is received and a confirmation channel that should be closed once subscriber has finished the shutdown.

func (*Shutdown) Wait

func (s *Shutdown) Wait() error

Wait blocks until shutdown.

func (*Shutdown) WaitToShutdownHTTP

func (s *Shutdown) WaitToShutdownHTTP(server *http.Server, subscriber string) error

WaitToShutdownHTTP synchronously waits for shutdown signal and shutdowns http server.