com.snowplowanalytics.snowplow.tracker.emitter

Interface Emitter

All Known Implementing Classes:

AbstractEmitter, BatchEmitter, SimpleEmitter

public interface Emitter

Emitter interface.

Method Summary

Modifier and Type	Method and Description
void	emit(TrackerPayload payload) Adds a payload to the buffer and checks whether we have reached the buffer limit yet.
void	flushBuffer() When the buffer limit is reached sending of the buffer is initiated.
java.util.List<TrackerPayload>	getBuffer() Returns the List of Payloads that are in the buffer.
int	getBufferSize() Gets the Emitter Buffer Size - Will always be 1 for SimpleEmitter
void	setBufferSize(int bufferSize) Customize the emitter buffer size to any valid integer greater than zero.

Method Detail

emit

void emit(TrackerPayload payload)

Adds a payload to the buffer and checks whether we have reached the buffer limit yet.

Parameters:

payload - an event payload

setBufferSize

void setBufferSize(int bufferSize)

Customize the emitter buffer size to any valid integer greater than zero. - Will only effect the BatchEmitter

Parameters:

bufferSize - number of events to collect before sending

flushBuffer

void flushBuffer()

When the buffer limit is reached sending of the buffer is initiated. This can be used to manually start sending.

getBufferSize

int getBufferSize()

Gets the Emitter Buffer Size - Will always be 1 for SimpleEmitter

Returns:

the buffer size

getBuffer

java.util.List<TrackerPayload> getBuffer()

Returns the List of Payloads that are in the buffer.

Returns:

the buffer payloads