SimpleBandwidthEstimator (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- net.i2p.client.streaming.impl.SimpleBandwidthEstimator

All Implemented Interfaces:
BandwidthEstimator
```
class SimpleBandwidthEstimator
extends Object
implements BandwidthEstimator
```
A Westwood+ bandwidth estimator with a first stage anti-aliasing low pass filter based on RTT, and the time-varying Westwood filter based on inter-arrival time. Ref: TCP Westwood: End-to-End Congestion Control for Wired/Wireless Networks Casetti et al (Westwood) Ref: End-to-End Bandwidth Estimation for Congestion Control in Packet Networks Grieco and Mascolo (Westwood+) Adapted from: Linux kernel tcp_westwood.c (GPLv2)

Constructor Summary
Constructors
Constructor and Description
SimpleBandwidthEstimator(I2PAppContext ctx, ConnectionOptions opts)
New estimator bound to the given options.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSample(int acked)` Records an arriving ack.
`float`	`getBandwidthEstimate()` Current bandwidth estimate.
`static int`	`getDecayFactor()` Returns the current EWMA decay factor.
`static void`	`setDecayFactor(int factor)` EWMA decay factor for new estimators.
`String`	`toString()` Debug representation of the estimate state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleBandwidthEstimator
```
SimpleBandwidthEstimator(I2PAppContext ctx,
                         ConnectionOptions opts)
```
    New estimator bound to the given options.
- Method Detail
  - addSample
```
public void addSample(int acked)
```
    Records an arriving ack.
    Specified by:
    addSample in interface BandwidthEstimator
    Parameters:
    acked - how many packets were acked with this ack
  - getBandwidthEstimate
```
public float getBandwidthEstimate()
```
    Current bandwidth estimate.
    Specified by:
    getBandwidthEstimate in interface BandwidthEstimator
    Returns:
    the current bandwidth estimate in packets/ms.
  - getDecayFactor
```
public static int getDecayFactor()
```
    Returns the current EWMA decay factor.
    Returns:
    the current decay factor
  - setDecayFactor
```
public static void setDecayFactor(int factor)
```
    EWMA decay factor for new estimators. Higher = more smoothing, lower = faster adaptation.
    Parameters:
    factor - the new decay factor (clamped to 2..16)
  - toString
```
public String toString()
```
    Debug representation of the estimate state.
    Overrides:
    toString in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method