graceful

Documentation

Index

• type Closer
  • func (cc *Closer) DetectShutdown(log logrus.FieldLogger) func()
  • func (cc *Closer) Register(name string, shut Shutdownable, timeout time.Duration)
• type Shutdownable

Types

type Closer

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

Closer handles shutdown of servers and connections

func (*Closer) DetectShutdown

func (cc *Closer) DetectShutdown(log logrus.FieldLogger) func()

DetectShutdown asynchronously waits for a shutdown signal and then shuts down gracefully Returns a function to trigger a shutdown from the outside, like cancelling a context

func (*Closer) Register

func (cc *Closer) Register(name string, shut Shutdownable, timeout time.Duration)

Register inserts a target to shutdown gracefully

type Shutdownable

type Shutdownable interface {
	Shutdown(context.Context) error
}

Shutdownable is a target that can be closed gracefully