com.snowplowanalytics.snowplow.emitter

Interface EventStore

public interface EventStore

Interface for the component that persists events before sending.

Method Summary

Modifier and Type	Method and Description
void	add(Payload payload) Adds an event to the store.
List<EmitterEvent>	getEmittableEvents(int queryLimit) Returns a list of EmittableEvent objects which contains events and related ids.
long	getSize() Returns amount of events currently in the store.
boolean	removeAllEvents() Empties the store of all the events.
boolean	removeEvent(long id) Removes an event from the store.
boolean	removeEvents(List<Long> ids) Removes a range of events from the store.

Method Detail

add

void add(@NonNull
         Payload payload)

Adds an event to the store.

Parameters:

payload - the payload to be added

removeEvent

boolean removeEvent(long id)

Removes an event from the store.

Parameters:

id - the identifier of the event in the store.

Returns:

a boolean of success to remove.

removeEvents

boolean removeEvents(@NonNull
                     List<Long> ids)

Removes a range of events from the store.

Parameters:

ids - the events' identifiers in the store.

Returns:

a boolean of success to remove.

removeAllEvents

boolean removeAllEvents()

Empties the store of all the events.

Returns:

a boolean of success to remove.

getSize

long getSize()

Returns amount of events currently in the store.

Returns:

the count of events in the store.

getEmittableEvents

@NonNull
List<EmitterEvent> getEmittableEvents(int queryLimit)

Returns a list of EmittableEvent objects which contains events and related ids.

Returns:

EmittableEvent objects containing eventIds and event payloads.