com.snowplowanalytics.snowplow.tracker.emitter

Class BatchEmitter

java.lang.Object

com.snowplowanalytics.snowplow.tracker.emitter.AbstractEmitter

com.snowplowanalytics.snowplow.tracker.emitter.BatchEmitter

All Implemented Interfaces:

Emitter, java.io.Closeable, java.lang.AutoCloseable

public class BatchEmitter
extends AbstractEmitter
implements java.io.Closeable

An emitter that emit a batch of events in a single call It uses the post method of under-laying http adapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchEmitter.Builder<T extends BatchEmitter.Builder<T>>

Field Summary

Fields inherited from class com.snowplowanalytics.snowplow.tracker.emitter.AbstractEmitter

executor, httpClientAdapter, requestCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchEmitter(BatchEmitter.Builder<?> builder)

Method Summary

Modifier and Type	Method and Description
static BatchEmitter.Builder<?>	builder()
void	close() On close attempt to send all remaining events.
void	emit(TrackerEvent event) Adds a TrackerEvent to the concurrent queue buffer
void	flushBuffer() Removes all events from the buffer and sends them
java.util.List<TrackerEvent>	getBuffer() Returns List of Events that are in the buffer.
int	getBufferSize() Gets the Emitter Buffer Size
void	setBufferSize(int bufferSize) Customize the emitter buffer size to any valid integer greater than zero.

Methods inherited from class com.snowplowanalytics.snowplow.tracker.emitter.AbstractEmitter

execute, isSuccessfulSend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchEmitter

protected BatchEmitter(BatchEmitter.Builder<?> builder)

Method Detail

builder

public static BatchEmitter.Builder<?> builder()

emit

public void emit(TrackerEvent event)

Adds a TrackerEvent to the concurrent queue buffer

Specified by:

emit in interface Emitter

Specified by:

emit in class AbstractEmitter

Parameters:

event - an event

flushBuffer

public void flushBuffer()

Description copied from class: AbstractEmitter

Removes all events from the buffer and sends them

Specified by:

flushBuffer in interface Emitter

Specified by:

flushBuffer in class AbstractEmitter

getBuffer

public java.util.List<TrackerEvent> getBuffer()

Returns List of Events that are in the buffer.

Specified by:

getBuffer in interface Emitter

Specified by:

getBuffer in class AbstractEmitter

Returns:

the buffered events

setBufferSize

public void setBufferSize(int bufferSize)

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

Specified by:

setBufferSize in interface Emitter

Specified by:

setBufferSize in class AbstractEmitter

Parameters:

bufferSize - number of events to collect before sending

getBufferSize

public int getBufferSize()

Gets the Emitter Buffer Size

Specified by:

getBufferSize in interface Emitter

Specified by:

getBufferSize in class AbstractEmitter

Returns:

the buffer size

close

public void close()

On close attempt to send all remaining events.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable