clean

Documentation

Overview

Package clean provides functionality to stop a list of services gracefully and synchronously.

Index

• type Cleaner
  • func New(stoppers ...stopper) *Cleaner
  • func (c *Cleaner) Clean()
  • func (c *Cleaner) Done()
  • func (c *Cleaner) Start()
  • func (c *Cleaner) With(stopper stopper) *Cleaner

Types

type Cleaner

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

Cleaner can be used to stop a list of services gracefully. To register an arbitrary amount of stoppers either use New or With. Start needs to be called to ready the Cleaner, then Clean will activate it. Done can be used to wait for Cleaner to run all registered stoppers.

func New

func New(stoppers ...stopper) *Cleaner

New creates a new cleaner.

func (*Cleaner) Clean

func (c *Cleaner) Clean()

Clean initiates the cleanup but does not wait for it to complete.

func (*Cleaner) Done

func (c *Cleaner) Done()

Done waits for the cleanup to complete.

func (*Cleaner) Start

func (c *Cleaner) Start()

Start blocks until it receives a stop message, stops all services gracefully and returns.

func (*Cleaner) With

func (c *Cleaner) With(stopper stopper) *Cleaner

With adds a new stopper to the cleaner.