com.microsoft.applicationinsights.internal.channel.common

Class TransmissionPolicyManager

java.lang.Object

com.microsoft.applicationinsights.internal.channel.common.TransmissionPolicyManager

All Implemented Interfaces:

TransmissionHandler, TransmissionHandlerObserver, Stoppable

public final class TransmissionPolicyManager
extends java.lang.Object
implements Stoppable, TransmissionHandlerObserver

This class is responsible for managing the transmission state. The class might be told to suspend transmission for the next 'X' seconds where the state is set to be one of the states defined in TransmissionPolicy The class will keep that state for the requested amount of time and will unbindFromRunawayChildThreads it, i.e. reset to 'unblock' when the timeout expires. Created by gupele on 6/29/2015.

Constructor Summary

Constructors

Constructor and Description
TransmissionPolicyManager(boolean throttlingIsEnabled) Create the TransmissionPolicyManager and set the ability to throttle.

Method Summary

Modifier and Type	Method and Description
void	addTransmissionHandler(TransmissionHandler handler) Used to add a TransmissionHandler to the collection stored by the TransmissionPolicyManager.
void	backoff() Suspend the transmission thread according to the current back off policy.
void	clearBackoff() Clear the current thread state and and reset the back off counter.
int	getMaxInstantRetries() Get the number of retries before performing a back off operation.
TransmissionPolicyStateFetcher	getTransmissionPolicyState() Get the policy state fetcher
void	onTransmissionSent(TransmissionHandlerArgs transmissionArgs) Called when a transmission is sent by the TransmissionOutput.
void	setMaxInstantRetries(int maxInstantRetries) Set the number of retries before performing a back off operation.
void	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Stop this transmission thread from sending.
void	suspendInSeconds(com.microsoft.applicationinsights.internal.channel.common.TransmissionPolicy policy, long suspendInSeconds) Suspend this transmission thread using the specified policy

Methods inherited from class java.lang.Object

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

Constructor Detail

TransmissionPolicyManager

public TransmissionPolicyManager(boolean throttlingIsEnabled)

Create the TransmissionPolicyManager and set the ability to throttle.

Parameters:

throttlingIsEnabled - Set whether the TransmissionPolicyManager can be throttled.

Method Detail

backoff

public void backoff()

Suspend the transmission thread according to the current back off policy.

clearBackoff

public void clearBackoff()

Clear the current thread state and and reset the back off counter.

suspendInSeconds

public void suspendInSeconds(com.microsoft.applicationinsights.internal.channel.common.TransmissionPolicy policy,
                             long suspendInSeconds)

Suspend this transmission thread using the specified policy

Parameters:

policy - The TransmissionPolicy to use for suspension

suspendInSeconds - The number of seconds to suspend.

stop

public void stop(long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

Stop this transmission thread from sending.

Specified by:

stop in interface Stoppable

getTransmissionPolicyState

public TransmissionPolicyStateFetcher getTransmissionPolicyState()

Get the policy state fetcher

Returns:

A TransmissionPolicyStateFetcher object

onTransmissionSent

public void onTransmissionSent(TransmissionHandlerArgs transmissionArgs)

Description copied from interface: TransmissionHandler

Called when a transmission is sent by the TransmissionOutput.

Specified by:

onTransmissionSent in interface TransmissionHandler

Parameters:

transmissionArgs - The TransmissionHandlerArgs for this handler.

addTransmissionHandler

public void addTransmissionHandler(TransmissionHandler handler)

Description copied from interface: TransmissionHandlerObserver

Used to add a TransmissionHandler to the collection stored by the TransmissionPolicyManager.

Specified by:

addTransmissionHandler in interface TransmissionHandlerObserver

Parameters:

handler - The handler to add to the collection.

setMaxInstantRetries

public void setMaxInstantRetries(int maxInstantRetries)

Set the number of retries before performing a back off operation.

Parameters:

maxInstantRetries - Number of retries

getMaxInstantRetries

public int getMaxInstantRetries()

Get the number of retries before performing a back off operation.

Returns:

Number of retries