goshutdowner

README

go-shutdowner

A simple library for graceful shutdowns

100% covered with unit tests.

See and try the example in /example to see the how things should be done.

Documentation

Index

• type ShutdownFunc
• type Shutdowner
  • func (s *Shutdowner) Add(f ShutdownFunc)
  • func (s *Shutdowner) Shutdown()
  • func (s *Shutdowner) ShutdownAndWait()
  • func (s *Shutdowner) Wait()

Types

type ShutdownFunc

type ShutdownFunc func()

type Shutdowner

type Shutdowner struct {
	// contains filtered or unexported fields
}

Simple struct, use like a sync.Mutex

 var s goshutdowner.Shutdowner
 s.Add(func() {
	 log.Println("Shutting down")
 })

func (*Shutdowner) Add

func (s *Shutdowner) Add(f ShutdownFunc)

Add a func, that should be called with s.Shutdown() or when receiving a shutdown signal

func (*Shutdowner) Shutdown

func (s *Shutdowner) Shutdown()

Trigger shutdown directly

func (*Shutdowner) ShutdownAndWait

func (s *Shutdowner) ShutdownAndWait()

Shutdown and wait till shutdown finished. Shorthand for:

s.Shutdown()
s.Wait()

func (*Shutdowner) Wait

func (s *Shutdowner) Wait()

Wait till all functions finished