shutdown

README

A simple shutdown watcher with a destructor.

Documentation

Index

• type Destructor
• type Shutdown
  • func New(destruct Destructor) *Shutdown
  • func (shutdown *Shutdown) Handler(handler http.Handler) http.Handler
  • func (shutdown *Shutdown) IsDown() bool
  • func (shutdown *Shutdown) Now(reason string)
  • func (shutdown *Shutdown) SetDestructor(destruct Destructor)
  • func (shutdown *Shutdown) Wait()

Types

type Destructor

type Destructor func()

type Shutdown

type Shutdown struct {
	Destructor Destructor

	*log.Logger
	// contains filtered or unexported fields
}

Shutdown listens for SIGINT and SIGTERM and executes the Destructor

func New

func New(destruct Destructor) *Shutdown

New generates a new Shutdown with typical defaults

func (*Shutdown) Handler

func (shutdown *Shutdown) Handler(handler http.Handler) http.Handler

wraps any request and checks to make sure that the server isn't shutting down

func (*Shutdown) IsDown

func (shutdown *Shutdown) IsDown() bool

IsDown checks to see if the shutdown has been triggered

func (*Shutdown) Now

func (shutdown *Shutdown) Now(reason string)

Now allows an application to trigger it's own shutdown

func (*Shutdown) SetDestructor

func (shutdown *Shutdown) SetDestructor(destruct Destructor)

func (*Shutdown) Wait

func (shutdown *Shutdown) Wait()

Wait is a func that allows the calling context to block until shutdown is finished