sync

Documentation

Index

• type Closer
  • func NewCloser() *Closer
  • func (c *Closer) Close()
  • func (c *Closer) Done() <-chan struct{}
  • func (c *Closer) WithCallback(cb func()) *Closer

Types

type Closer

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

Closer implements a primitive to close a channel that signals process termination while allowing a caller to call Close multiple times safely. It should be used in cases where guarantees cannot be made about when and how many times closure is executed.

func NewCloser

func NewCloser() *Closer

NewCloser returns a reference to a new Closer.

func (*Closer) Close

func (c *Closer) Close()

Close gracefully closes the Closer. A caller should only call Close once, but it is safe to call it successive times.

func (*Closer) Done

func (c *Closer) Done() <-chan struct{}

Done returns the internal done channel allowing the caller either block or wait for the Closer to be terminated/closed.

func (*Closer) WithCallback

func (c *Closer) WithCallback(cb func()) *Closer

WithCallback adds additional logic to be triggered on the closure of the Closer