<![CDATA[
# DeviceAtlas Connectivity Analyser #
The DeviceAtlas Connectivity Analyser is used to measure the round trip time when
sending a payload of a fixed size to a client. This measures a combination of
latency and bandwidth. The measured time is then used to categorize the
client's current connection into low, medium or high.
### Dependencies ###
This library depends on the following third party libraries:
* SLF4J (Simple Logging Facade for Java) - v1.7.2 -- http://www.slf4j.org/
### Usage ###
1. Include ConnectivityAnalyser_1.1.jar inside your web application
2. In your web.xml, include the fo1lowing:
```java
<filter>
<filter-name>ConnectivityAnalyser</filter-name>
<filter-class>mobi.mtld.connectivityanalyser.filter.ConnectivityAnalyser</filter-class>
...
(Optional please read below about options for more details)
<init-param>
<param-name>frequency</param-name>
<param-value>10</param-name>
</init-param>
</filter>
...
<filter-mapping>
<filter-name>ConnectivityAnalyser</filter-name>
...
</filter-mapping>
```
Please see the example application for more detail.
### Options ###
* payload
- The amount of data to send to the client as part of the bandwidth
measurement. Defaults to 1KB.
* frequency
- Defines how often to re-measure the connectivity analyser for a given
user. If this is set to 1 then the network performance is checked on
every request. If it is greater than 1 the network performance is
only checked every X requests and the previous values are returned
until X requests is reached.
* lowquality/midquality
- The thresholds to define the low and mid tiers. The threshold is
defined in ms. Everything faster than the mid threshold is
classified as high quality.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
_(c) 2021 DeviceAtlas Limited. All rights reserved. https://deviceatlas.com _
<!-- HTML+JS for document formatting when opened in browser -->
<div class="btn-group" id="main-menu" style="float:right"><a class="btn dropdown-toggle" data-toggle="dropdown" href="#">Menu<span class="caret"></span></a><ul class="dropdown-menu"><li><a href="README.html">Main</a></li><li><a href="README.DeviceApi.html">Device Detection API</a></li><li><a href="README.DeviceApi-Config.html">Device Detection API Config</a></li><li><a href="README.Upgrade.html">Device Detection API Upgrade</a></li><li><a href="DeviceApiJavadoc/index.html">Device API Javadoc</a></li><li class="divider"></li><li><a href="README.CarrierApi.html">Carrier Identification API</a></li><li><a href="CarrierApiJavadoc/index.html">Carrier API Javadoc</a></li><li class="divider"></li><li><a href="README.ClientSide.html">Client-side Component</a></li><li class="disabled"><a href="README.ConnectivityAnalyser.html">Connectivity Analyser</a></li></ul></div>]]>