shutdown

Documentation

Index

• type Listener
• type ListenerFunc
  • func (f ListenerFunc) OnShutdown(ctx context.Context) error
• type Shutdown
  • func New(timeout time.Duration, listeners map[string]Listener) *Shutdown
  • func (s *Shutdown) Wait() (os.Signal, error)

Types

type Listener

type Listener interface {
	OnShutdown(context.Context) error
}

type ListenerFunc

type ListenerFunc func(context.Context) error

func (ListenerFunc) OnShutdown

func (f ListenerFunc) OnShutdown(ctx context.Context) error

type Shutdown

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

func New

func New(timeout time.Duration, listeners map[string]Listener) *Shutdown

func (*Shutdown) Wait

func (s *Shutdown) Wait() (os.Signal, error)

Wait receive an message that will be printed out to logger before blocking. Wait block the call and wait for SIGINT, SIGTERM or SIGHUP signals. After signal is received, this method will run Listener.OnShutdown in parallel, the operation must complete under specified timeout. If any listeners return an error or operation is timed out this method will call os.Exit(1).