com.microsoft.applicationinsights.internal.channel.common

Class TelemetryBuffer<T>

java.lang.Object

com.microsoft.applicationinsights.internal.channel.common.TelemetryBuffer<T>

public class TelemetryBuffer<T>
extends java.lang.Object

The class is responsible for getting instances of Telemetry It is responsible for managing the buffers. Once a new buffer is created it will schedule a call to pick up the buffer. If the buffer is full before the timeout expired, it will initiate a 'send now' activity to send the buffer asap. The class is responsible for handing the corner cases that might rise Created by gupele on 12/17/2014.

Constructor Summary

Constructors

Constructor and Description
TelemetryBuffer(TelemetriesTransmitter<T> sender, LimitsEnforcer maxTelemetriesInBatchEnforcer, LimitsEnforcer transmitBufferTimeoutInSecondsEnforcer) The constructor needs to get the 'sender' we work with

Method Summary

Modifier and Type	Method and Description
void	add(T telemetry) The method will add the incoming Telemetry to its internal container of Telemetries If that is the first instance in the container, we schedule a 'pick-up' in a configurable amount of time If by adding that item we exceeded the maximum number of instances, we trigger a send request now.
void	flush() The method will flush the telemetries currently in the buffer to the TelemetriesTransmitter
int	getMaxTelemetriesInBatch() Gets the maximum number of telemetries in a batch
int	getTransmitBufferTimeoutInSeconds() Gets the transmit buffer timeout in seconds
void	setMaxTelemetriesInBatch(int value) Sets the maximum number of telemetries in a batch
void	setTransmitBufferTimeoutInSeconds(int value) Sets the transmit buffer timeout in seconds

Methods inherited from class java.lang.Object

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

Constructor Detail

TelemetryBuffer

public TelemetryBuffer(TelemetriesTransmitter<T> sender,
                       LimitsEnforcer maxTelemetriesInBatchEnforcer,
                       LimitsEnforcer transmitBufferTimeoutInSecondsEnforcer)

The constructor needs to get the 'sender' we work with

Parameters:

sender - The sender object for transmitting the telemetries

maxTelemetriesInBatchEnforcer - For getting the number of maximum number of telemetries in a batch within limits

transmitBufferTimeoutInSecondsEnforcer - For getting the number of transmit buffer timeout in seconds within limits

Method Detail

setMaxTelemetriesInBatch

public void setMaxTelemetriesInBatch(int value)

Sets the maximum number of telemetries in a batch

Parameters:

value - The max amount of Telemetries that are allowed in a batch.

getMaxTelemetriesInBatch

public int getMaxTelemetriesInBatch()

Gets the maximum number of telemetries in a batch

Returns:

The maximum number of telemetries in a batch

setTransmitBufferTimeoutInSeconds

public void setTransmitBufferTimeoutInSeconds(int value)

Sets the transmit buffer timeout in seconds

Parameters:

value - The amount of time to wait before sending the buffer.

getTransmitBufferTimeoutInSeconds

public int getTransmitBufferTimeoutInSeconds()

Gets the transmit buffer timeout in seconds

Returns:

The transmit buffer timeout in seconds

add

public void add(T telemetry)

The method will add the incoming Telemetry to its internal container of Telemetries If that is the first instance in the container, we schedule a 'pick-up' in a configurable amount of time If by adding that item we exceeded the maximum number of instances, we trigger a send request now. Note that a lock is used to make sure we avoid race conditions and to make sure that we cleanly move from a ready to send buffer to a new one

Parameters:

telemetry - The Telemetry to add to the buffer.

flush

public void flush()

The method will flush the telemetries currently in the buffer to the TelemetriesTransmitter