pump

Documentation

Overview

Package pump provides an infinitely buffered event channel.

Index

• type Pump
  • func Make() Pump
  • func (p *Pump) Events() <-chan interface{}
  • func (p *Pump) Release()
  • func (p *Pump) Send(event interface{})

Types

type Pump

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

Pump is an event pump, such that calling Send(e) will eventually send e on the event channel, in order, but Send will always complete soon, even if nothing is receiving on the event channel. It is effectively an infinitely buffered channel.

In particular, goroutine A calling p.Send will not deadlock even if goroutine B that's responsible for receiving on p.Events() is currently blocked trying to send to A on a separate channel.

func Make

func Make() Pump

Make returns a new Pump. Call Release to stop pumping events.

func (*Pump) Events

func (p *Pump) Events() <-chan interface{}

Events returns the event channel.

func (*Pump) Release

func (p *Pump) Release()

Release stops the event pump. Pending events may or may not be delivered on the event channel. Calling Release will not close the event channel.

func (*Pump) Send

func (p *Pump) Send(event interface{})

Send sends an event on the event channel.