publisher

Documentation

Index

• type Batch
• type Event
  • func (e *Event) Guaranteed() bool
• type EventFlags

Types

type Batch

type Batch interface {
	Events() []Event

	// signals
	ACK()
	Drop()
	Retry()
	RetryEvents(events []Event)
	Cancelled()
	CancelledEvents(events []Event)
}

Batch is used to pass a batch of events to the outputs and asynchronously listening for signals from these outpts. After a batch is processed (completed or errors), one of the signal methods must be called.

type Event

type Event struct {
	Content beat.Event
	Flags   EventFlags
}

Event is used by the publisher pipeline and broker to pass additional meta-data to the consumers/outputs.

func (*Event) Guaranteed

func (e *Event) Guaranteed() bool

Guaranteed checks if the event must not be dropped by the output or the publisher pipeline.

type EventFlags

type EventFlags uint8

EventFlags provides additional flags/option types for used with the outputs.

const (
	// GuaranteedSend requires an output to not drop the event on failure, but
	// retry until ACK.
	GuaranteedSend EventFlags = 0x01
)