firehose

Documentation

Index

• type Firehose
  • func Start() *Firehose
  • func (f *Firehose) Close()
  • func (f *Firehose) GetEventCount() int64
  • func (f *Firehose) ResetEventCount()
  • func (f *Firehose) RestartNozzle()
• type OneToOneEnvelope
  • func NewOneToOneEnvelope(size int, alerter diodes.Alerter) *OneToOneEnvelope
  • func (d *OneToOneEnvelope) Next() *loggregator_v2.Envelope
  • func (d *OneToOneEnvelope) Set(data *loggregator_v2.Envelope)
  • func (d *OneToOneEnvelope) TryNext() (*loggregator_v2.Envelope, bool)

Types

type Firehose

type Firehose struct {
	Queue      *OneToOneEnvelope
	EventCount int64
	// contains filtered or unexported fields
}

Firehose Object...

func Start

func Start() *Firehose

Start New Firehose

func (*Firehose) Close

func (f *Firehose) Close()

Close Firehose

func (*Firehose) GetEventCount

func (f *Firehose) GetEventCount() int64

GetEventCount ...

func (*Firehose) ResetEventCount

func (f *Firehose) ResetEventCount()

ResetEventCount ...

func (*Firehose) RestartNozzle

func (f *Firehose) RestartNozzle()

RestartNozzle calls the context cancel function, then starts the nozzle again.

type OneToOneEnvelope

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

OneToOneEnvelope ...

func NewOneToOneEnvelope

func NewOneToOneEnvelope(size int, alerter diodes.Alerter) *OneToOneEnvelope

NewOneToOneEnvelope ...

func (*OneToOneEnvelope) Next

func (d *OneToOneEnvelope) Next() *loggregator_v2.Envelope

Next will return the next V2 envelope to be read from the diode. If the diode is empty this method will block until an envelope is available to be read.

func (*OneToOneEnvelope) Set

func (d *OneToOneEnvelope) Set(data *loggregator_v2.Envelope)

Set inserts the given V2 envelope into the diode.

func (*OneToOneEnvelope) TryNext

func (d *OneToOneEnvelope) TryNext() (*loggregator_v2.Envelope, bool)

TryNext returns the next V2 envelope to be read from the diode. If the diode is empty it will return a nil envelope and false for the bool.