com.snowplowanalytics.snowplow.tracker.emitter

Interface Emitter

All Known Implementing Classes:

BatchEmitter

public interface Emitter

Emitter interface.

Method Summary

Modifier and Type	Method and Description
boolean	add(TrackerPayload payload) Adds a payload to the buffer and checks whether we have reached the buffer limit yet.
void	close() Safely shuts down the Emitter.
void	flushBuffer() This can be used to manually send all buffered events.
int	getBatchSize() Gets the Emitter Batch Size
java.util.List<TrackerPayload>	getBuffer() Returns the List of Payloads that are in the buffer.
void	setBatchSize(int batchSize) Customize the emitter batch size to any valid integer greater than zero.

Method Detail

add

boolean add(TrackerPayload payload)

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

Parameters:

payload - a payload to be emitted

Returns:

if the payload was added to the buffer

setBatchSize

void setBatchSize(int batchSize)

Customize the emitter batch size to any valid integer greater than zero.

Parameters:

batchSize - number of events to collect before sending

flushBuffer

void flushBuffer()

This can be used to manually send all buffered events.

getBatchSize

int getBatchSize()

Gets the Emitter Batch Size

Returns:

the batch size

getBuffer

java.util.List<TrackerPayload> getBuffer()

Returns the List of Payloads that are in the buffer.

Returns:

the buffer events

close

void close()

Safely shuts down the Emitter.