Snowplow Android Tracker 3.1.2
Public Member Functions | Public Attributes | List of all members
com.snowplowanalytics.snowplow.configuration.EmitterConfiguration Class Reference
Inheritance diagram for com.snowplowanalytics.snowplow.configuration.EmitterConfiguration:
com.snowplowanalytics.snowplow.configuration.Configuration com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate

Public Member Functions

 EmitterConfiguration ()
 
EventStore getEventStore ()
 
BufferOption getBufferOption ()
 
void setBufferOption (@NonNull BufferOption bufferOption)
 
int getEmitRange ()
 
void setEmitRange (int emitRange)
 
int getThreadPoolSize ()
 
void setThreadPoolSize (int threadPoolSize)
 
long getByteLimitGet ()
 
void setByteLimitGet (long byteLimitGet)
 
long getByteLimitPost ()
 
void setByteLimitPost (long byteLimitPost)
 
RequestCallback getRequestCallback ()
 
void setRequestCallback (@Nullable RequestCallback requestCallback)
 
EmitterConfiguration bufferOption (@NonNull BufferOption bufferOption)
 
EmitterConfiguration emitRange (int emitRange)
 
EmitterConfiguration threadPoolSize (int threadPoolSize)
 
EmitterConfiguration byteLimitGet (int byteLimitGet)
 
EmitterConfiguration byteLimitPost (int byteLimitPost)
 
EmitterConfiguration eventStore (@Nullable EventStore eventStore)
 
EmitterConfiguration requestCallback (@Nullable RequestCallback requestCallback)
 
EmitterConfiguration copy ()
 

Public Attributes

BufferOption bufferOption
 
int emitRange
 
int threadPoolSize
 
long byteLimitGet
 
long byteLimitPost
 
RequestCallback requestCallback
 
EventStore eventStore
 

Detailed Description

It allows the tracker configuration from the emission perspective. The EmitterConfiguration can be used to setup details about how the tracker should treat the events to emit to the collector.

Definition at line 16 of file EmitterConfiguration.java.

Constructor & Destructor Documentation

◆ EmitterConfiguration()

com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.EmitterConfiguration ( )

It sets a default EmitterConfiguration. Default values: bufferOption = BufferOption.Single; emitRange = 150; threadPoolSize = 15; byteLimitGet = 40000; byteLimitPost = 40000;

Definition at line 67 of file EmitterConfiguration.java.

Member Function Documentation

◆ bufferOption()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.bufferOption ( @NonNull BufferOption  bufferOption)

Sets whether the buffer should send events instantly or after the buffer has reached it's limit. By default, this is set to BufferOption Default.

Definition at line 152 of file EmitterConfiguration.java.

◆ byteLimitGet()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.byteLimitGet ( int  byteLimitGet)

Maximum amount of bytes allowed to be sent in a payload in a GET request.

Definition at line 179 of file EmitterConfiguration.java.

◆ byteLimitPost()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.byteLimitPost ( int  byteLimitPost)

Maximum amount of bytes allowed to be sent in a payload in a POST request.

Definition at line 188 of file EmitterConfiguration.java.

◆ copy()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.copy ( )

◆ emitRange()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.emitRange ( int  emitRange)

Maximum number of events collected from the EventStore to be sent in a request.

Definition at line 161 of file EmitterConfiguration.java.

◆ eventStore()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.eventStore ( @Nullable EventStore  eventStore)

Custom component with full ownership for persisting events before to be sent to the collector. If it's not set the tracker will use a SQLite database as default EventStore.

Definition at line 198 of file EmitterConfiguration.java.

◆ getBufferOption()

BufferOption com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getBufferOption ( )

Whether the buffer should send events instantly or after the buffer has reached it's limit. By default, this is set to BufferOption Default.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 85 of file EmitterConfiguration.java.

◆ getByteLimitGet()

long com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getByteLimitGet ( )

Maximum amount of bytes allowed to be sent in a payload in a GET request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 114 of file EmitterConfiguration.java.

◆ getByteLimitPost()

long com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getByteLimitPost ( )

Maximum amount of bytes allowed to be sent in a payload in a POST request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 124 of file EmitterConfiguration.java.

◆ getEmitRange()

int com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getEmitRange ( )

Maximum number of events collected from the EventStore to be sent in a request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 95 of file EmitterConfiguration.java.

◆ getEventStore()

EventStore com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getEventStore ( )

Custom component with full ownership for persisting events before to be sent to the collector. If it's not set the tracker will use a SQLite database as default EventStore.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 79 of file EmitterConfiguration.java.

◆ getRequestCallback()

RequestCallback com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getRequestCallback ( )

Callback called for each request performed by the tracker to the collector.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 135 of file EmitterConfiguration.java.

◆ getThreadPoolSize()

int com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.getThreadPoolSize ( )

Maximum number of threads working in parallel in the tracker to send requests.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Reimplemented in com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationUpdate.

Definition at line 105 of file EmitterConfiguration.java.

◆ requestCallback()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.requestCallback ( @Nullable RequestCallback  requestCallback)

Callback called for each request performed by the tracker to the collector.

Definition at line 207 of file EmitterConfiguration.java.

◆ setBufferOption()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setBufferOption ( @NonNull BufferOption  bufferOption)

Whether the buffer should send events instantly or after the buffer has reached it's limit. By default, this is set to BufferOption Default.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Definition at line 90 of file EmitterConfiguration.java.

◆ setByteLimitGet()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setByteLimitGet ( long  byteLimitGet)

Maximum amount of bytes allowed to be sent in a payload in a GET request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Definition at line 119 of file EmitterConfiguration.java.

◆ setByteLimitPost()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setByteLimitPost ( long  byteLimitPost)

Maximum amount of bytes allowed to be sent in a payload in a POST request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Definition at line 129 of file EmitterConfiguration.java.

◆ setEmitRange()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setEmitRange ( int  emitRange)

Maximum number of events collected from the EventStore to be sent in a request.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Definition at line 100 of file EmitterConfiguration.java.

◆ setRequestCallback()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setRequestCallback ( @Nullable RequestCallback  requestCallback)

Callback called for each request performed by the tracker to the collector.

Implements com.snowplowanalytics.snowplow.internal.emitter.EmitterConfigurationInterface.

Definition at line 140 of file EmitterConfiguration.java.

◆ setThreadPoolSize()

void com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.setThreadPoolSize ( int  threadPoolSize)

Definition at line 109 of file EmitterConfiguration.java.

◆ threadPoolSize()

EmitterConfiguration com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.threadPoolSize ( int  threadPoolSize)

Maximum number of threads working in parallel in the tracker to send requests.

Definition at line 170 of file EmitterConfiguration.java.

Member Data Documentation

◆ bufferOption

BufferOption com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.bufferOption
See also
#bufferOption(BufferOption)

Definition at line 22 of file EmitterConfiguration.java.

◆ byteLimitGet

long com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.byteLimitGet
See also
byteLimitGet(int)

Definition at line 37 of file EmitterConfiguration.java.

◆ byteLimitPost

long com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.byteLimitPost
See also
byteLimitPost(int)

Definition at line 42 of file EmitterConfiguration.java.

◆ emitRange

int com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.emitRange
See also
emitRange(int)

Definition at line 27 of file EmitterConfiguration.java.

◆ eventStore

EventStore com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.eventStore
See also
#eventStore(EventStore)

Definition at line 54 of file EmitterConfiguration.java.

◆ requestCallback

RequestCallback com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.requestCallback
See also
#requestCallback(RequestCallback)

Definition at line 48 of file EmitterConfiguration.java.

◆ threadPoolSize

int com.snowplowanalytics.snowplow.configuration.EmitterConfiguration.threadPoolSize
See also
threadPoolSize(int)

Definition at line 32 of file EmitterConfiguration.java.


The documentation for this class was generated from the following file: