BandwidthHistory (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.util.SimpleTimer2.TimedEvent
- - net.i2p.router.BandwidthHistory

All Implemented Interfaces:
Runnable
```
public class BandwidthHistory
extends SimpleTimer2.TimedEvent
```
Records live bandwidth samples every second for the minigraph. Maintains a 1200-entry ring buffer (20 min at 1s resolution) and flushes to /tmp/i2p-bandwidth.dat every 60 seconds so data survives page refreshes and router restarts. Started automatically by Router.startup(). Accessed by SidebarRenderer.getDataAttributes() to populate the canvas minigraph with real data instead of interpolated RRD points.

Field Summary
Fields
Modifier and Type Field and Description
static int CAPACITY
Buffer: 1200 entries = 20 min at 1s
static long SAMPLE_INTERVAL
Sample once per second
- Fields inherited from class net.i2p.util.SimpleTimer2.TimedEvent
  _state, DEFAULT_FUZZ

Fields
Modifier and Type	Field and Description
`static int`	`CAPACITY` Buffer: 1200 entries = 20 min at 1s
`static long`	`SAMPLE_INTERVAL` Sample once per second

Constructor Summary
Constructors
Constructor and Description
BandwidthHistory(RouterContext ctx)
Create a bandwidth history.

Constructors
Constructor and Description
`BandwidthHistory(RouterContext ctx)` Create a bandwidth history.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getCapacity()` The ring buffer capacity.
`int`	`getCount()` The number of stored samples.
`static BandwidthHistory`	`getInstance()` The singleton instance.
`String`	`getLastRx(int n)` Return the last `n` receive values as a comma-separated string.
`String`	`getLastTx(int n)` Return the last `n` send values as a comma-separated string.
`void`	`record(long rx, long tx)` Add a sample to the ring buffer.
`(package private) void`	`save()` Write the ring buffer to disk.
`void`	`timeReached()` Sample bandwidth limiter and record.

Methods inherited from class net.i2p.util.SimpleTimer2.TimedEvent
cancel, forceReschedule, reschedule, reschedule, run, schedule, setFuzz, setPool, toString

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

- Field Detail
  - CAPACITY
```
public static final int CAPACITY
```
    Buffer: 1200 entries = 20 min at 1s
    See Also:
    Constant Field Values
  - SAMPLE_INTERVAL
```
public static final long SAMPLE_INTERVAL
```
    Sample once per second
    See Also:
    Constant Field Values
- Constructor Detail
  - BandwidthHistory
```
public BandwidthHistory(RouterContext ctx)
```
    Create a bandwidth history.
    Parameters:
    ctx - may be null in unit tests
- Method Detail
  - getCapacity
```
public int getCapacity()
```
    The ring buffer capacity.
    Returns:
    the ring buffer capacity
  - getCount
```
public int getCount()
```
    The number of stored samples.
    Returns:
    number of stored samples
  - getInstance
```
public static BandwidthHistory getInstance()
```
    The singleton instance.
    Returns:
    the singleton, or null if not yet created
  - getLastRx
```
public String getLastRx(int n)
```
    Return the last n receive values as a comma-separated string. Oldest value first, most recent last. Empty string if no data.
    Parameters:
    n - the number of values to return
    Returns:
    comma-separated string of the last n values
  - getLastTx
```
public String getLastTx(int n)
```
    Return the last n send values as a comma-separated string. Oldest value first, most recent last. Empty string if no data.
    Parameters:
    n - the number of values to return
    Returns:
    comma-separated string of the last n values
  - record
```
public void record(long rx,
                   long tx)
```
    Add a sample to the ring buffer.
    Parameters:
    rx - the receive bandwidth in Bps
    tx - the transmit bandwidth in Bps
  - save
```
void save()
```
    Write the ring buffer to disk.
  - timeReached
```
public void timeReached()
```
    Sample bandwidth limiter and record. Reschedules itself at 1s.
    Specified by:
    timeReached in class SimpleTimer2.TimedEvent

Class BandwidthHistory

Field Summary

Fields inherited from class net.i2p.util.SimpleTimer2.TimedEvent

Constructor Summary

Method Summary

Methods inherited from class net.i2p.util.SimpleTimer2.TimedEvent

Methods inherited from class java.lang.Object

Field Detail

CAPACITY

SAMPLE_INTERVAL

Constructor Detail

BandwidthHistory

Method Detail

getCapacity

getCount

getInstance

getLastRx

getLastTx

record

save

timeReached