com.snowplowanalytics.snowplow.tracker.emitter

Interface EventStore

All Known Implementing Classes:

InMemoryEventStore

public interface EventStore

EventStore interface. For buffering events in the Emitter.

Method Summary

Modifier and Type	Method and Description
boolean	addEvent(TrackerPayload trackerPayload) Add TrackerPayload to buffer.
java.util.List<TrackerPayload>	cleanupAfterSendingAttempt(boolean needRetry, long batchId) Finish processing events after a request has been made.
java.util.List<TrackerPayload>	getAllEvents() Get a copy of all the TrackerPayloads in the buffer.
BatchPayload	getEventsBatch(int numberToGet) Remove some TrackerPayloads from the buffer.
int	size() Get the current size of the buffer.

Method Detail

addEvent

boolean addEvent(TrackerPayload trackerPayload)

Add TrackerPayload to buffer.

Parameters:

trackerPayload - the payload to add

Returns:

success or not

getEventsBatch

BatchPayload getEventsBatch(int numberToGet)

Remove some TrackerPayloads from the buffer.

Parameters:

numberToGet - how many payloads to get

Returns:

a BatchPayload wrapper

getAllEvents

java.util.List<TrackerPayload> getAllEvents()

Get a copy of all the TrackerPayloads in the buffer.

Returns:

List of all the stored events

cleanupAfterSendingAttempt

java.util.List<TrackerPayload> cleanupAfterSendingAttempt(boolean needRetry,
                                                          long batchId)

Finish processing events after a request has been made.

Parameters:

needRetry - if another attempt should be made to send the events

batchId - the ID of the batch of events

Returns:

list of TrackerPayloads

size

int size()

Get the current size of the buffer.

Returns:

number of events currently in the buffer