com.dynatrace.openkit.core

Class BeaconSender

java.lang.Object

com.dynatrace.openkit.core.BeaconSender

public class BeaconSender
extends java.lang.Object

The BeaconSender is responsible for asynchronously sending the Beacons to the provided endpoint.

The BeaconSender manages the thread running OpenKit communication in the background.

Constructor Summary

Constructors

Constructor and Description
BeaconSender(Logger logger, Configuration configuration, HTTPClientProvider clientProvider, TimingProvider timingProvider) Create a new BeaconSender.

Method Summary

Modifier and Type	Method and Description
void	finishSession(SessionImpl session) When finishing a Session, remove it from open Sessions and put it into finished Sessions.
void	initialize() Start beacon sender thread.
boolean	isInitialized() Get a boolean indicating whether OpenKit has been initialized or not.
void	shutdown() Shutdown the BeaconSender and wait until it's shutdown (at most SHUTDOWN_TIMEOUT milliseconds.
void	startSession(SessionImpl session) When starting a new Session, put it into open Sessions.
boolean	waitForInit() Wait until OpenKit is fully initialized or a shutdown request has been made.
boolean	waitForInit(long timeoutMillis) Wait until OpenKit is fully initialized or a shutdown request has been made or given timeout expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeaconSender

public BeaconSender(Logger logger,
                    Configuration configuration,
                    HTTPClientProvider clientProvider,
                    TimingProvider timingProvider)

Create a new BeaconSender.

To start the beacon sending the initialize() method must be called.

Parameters:

logger -

configuration - OpenKit configuration.

clientProvider - Used for retrieving an HTTPClient instance.

timingProvider - Used for some timing related things.

Method Detail

initialize

public void initialize()

Start beacon sender thread.

Note: The beacon sender has to perform some initialization code, which is done in the background, before it actually starts sending beacons. If it's a must to have OpenKit fully initialized use the waitForInit() method to wait until initialized.

waitForInit

public boolean waitForInit()

Wait until OpenKit is fully initialized or a shutdown request has been made.

This method might hang forever.

Returns:

true if OpenKit is fully initialized, or false if shutdown has been requested during init phase.

waitForInit

public boolean waitForInit(long timeoutMillis)

Wait until OpenKit is fully initialized or a shutdown request has been made or given timeout expired.

Parameters:

timeoutMillis - The maximum number of milliseconds to wait for initialization being completed.

Returns:

true if OpenKit is fully initialized, or false if shutdown has been requested during init phase.

isInitialized

public boolean isInitialized()

Get a boolean indicating whether OpenKit has been initialized or not.

Returns:

true if OpenKit has been initialized, false otherwise.

shutdown

public void shutdown()

Shutdown the BeaconSender and wait until it's shutdown (at most SHUTDOWN_TIMEOUT milliseconds.

startSession

public void startSession(SessionImpl session)

When starting a new Session, put it into open Sessions.

A session is only put into the open Sessions if capturing is enabled. In case capturing is disabled, this method has no effect.

Parameters:

session - Session to start.

finishSession

public void finishSession(SessionImpl session)

When finishing a Session, remove it from open Sessions and put it into finished Sessions.

As soon as a session get's finished it will be transferred to the server.

Parameters:

session - Session to finish.