EmitterController

interface EmitterController : EmitterConfigurationInterface

Controller for managing how events are sent.

Functions

Link copied to clipboard
abstract fun pause()

Pause emitting events. Emitting events will be suspended until resumed again. Suitable for low bandwidth situations.

Link copied to clipboard
abstract fun resume()

Resume emitting events if previously paused. The emitter will resume emitting events again.

Properties

Link copied to clipboard

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

Link copied to clipboard
abstract var byteLimitGet: Long

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

Link copied to clipboard
abstract var byteLimitPost: Long

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

Link copied to clipboard

Custom retry rules for HTTP status codes returned from the Collector. The dictionary is a mapping of integers (status codes) to booleans (true for retry and false for not retry).

Link copied to clipboard
abstract val dbCount: Long

Number of events recorded in the EventStore.

Link copied to clipboard
abstract var emitRange: Int

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

Link copied to clipboard
abstract val 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.

Link copied to clipboard
abstract val isSending: Boolean

Whether the emitter is currently sending events.

Link copied to clipboard

Limit for the maximum duration of how long events should be kept in the event store if they fail to be sent. Defaults to 30 days.

Link copied to clipboard
abstract var maxEventStoreSize: Long

Limit for the maximum number of unsent events to keep in the event store. Defaults to 1000.

Link copied to clipboard

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

Link copied to clipboard

Whether to retry sending events that failed to be sent to the collector.

Link copied to clipboard

Whether to anonymise server-side user identifiers including the network_userid and user_ipaddress

Link copied to clipboard
abstract val threadPoolSize: Int

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