TunnelHistory (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.peermanager.TunnelHistory

public class TunnelHistory
extends Object

Tunnel related history information

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static long[]`	`RATES` Rate periods for history tracking
`static int`	`TUNNEL_REJECT_BANDWIDTH` tunnel rejection due to excess bandwidth usage - used for most rejections even if not really for bandwidth
`static int`	`TUNNEL_REJECT_CRIT` tunnel rejection due to system failure - not currently used
`static int`	`TUNNEL_REJECT_PROBABALISTIC_REJECT` probabalistic tunnel rejection due to a flood of requests - infrequent
`static int`	`TUNNEL_REJECT_STREAMING_NACK` Streaming NACK - peer accepted tunnel but can't deliver data
`static int`	`TUNNEL_REJECT_TRANSIENT_OVERLOAD` tunnel rejection due to temporary cpu/job/tunnel overload - rare

Constructor Summary
Constructors
Constructor and Description
TunnelHistory(RouterContext context, String statGroup)
TunnelHistory.

Constructors
Constructor and Description
`TunnelHistory(RouterContext context, String statGroup)` TunnelHistory.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`coalesceStats()` coalesceStats.
`double`	`getAcceptanceRatio()` Calculate the ratio of accepted to rejected tunnel requests.
`RateStat`	`getFailedRate()`
`long`	`getLastAgreedTo()` when the peer last agreed to participate in a tunnel
`long`	`getLastFailed()` when the last tunnel the peer participated in failed
`long`	`getLastRejectedBandwidth()` when the peer last refused to participate in a tunnel complaining of bandwidth overload
`long`	`getLastRejectedCritical()` when the peer last refused to participate in a tunnel with level of critical
`long`	`getLastRejectedProbabalistic()` when the peer last refused to participate in a tunnel probabalistically
`long`	`getLastRejectedTransient()` when the peer last refused to participate in a tunnel complaining of transient overload
`long`	`getLastTestedSuccessfully()` when the peer last passed a tunnel test
`long`	`getLifetimeAgreedTo()` total tunnels the peer has agreed to participate in
`long`	`getLifetimeFailed()` total tunnels the peer has agreed to participate in that were later marked as failed prematurely
`long`	`getLifetimeRejected()` total tunnels the peer has refused to participate in
`RateStat`	`getRejectionRate()`
`void`	`incrementAgreedTo()` incrementAgreedTo.
`void`	`incrementFailed(int pct)` Define this rate as the probability it really failed
`void`	`incrementProcessed(int processedSuccessfully, int failedProcessing)` incrementProcessed.
`void`	`incrementRejected(int severity)`
`void`	`incrementTestSucceeded()` Record that a tunnel test through this peer succeeded.
`void`	`load(Properties props)` load.
`void`	`store(OutputStream out)` store.
`void`	`store(OutputStream out, boolean addComments)` write out the data from the profile to the stream

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

- Field Detail
  - RATES
```
static final long[] RATES
```
    Rate periods for history tracking
  - TUNNEL_REJECT_BANDWIDTH
```
public static final int TUNNEL_REJECT_BANDWIDTH
```
    tunnel rejection due to excess bandwidth usage - used for most rejections even if not really for bandwidth
    See Also:
    Constant Field Values
  - TUNNEL_REJECT_CRIT
```
public static final int TUNNEL_REJECT_CRIT
```
    tunnel rejection due to system failure - not currently used
    See Also:
    Constant Field Values
  - TUNNEL_REJECT_PROBABALISTIC_REJECT
```
public static final int TUNNEL_REJECT_PROBABALISTIC_REJECT
```
    probabalistic tunnel rejection due to a flood of requests - infrequent
    See Also:
    Constant Field Values
  - TUNNEL_REJECT_STREAMING_NACK
```
public static final int TUNNEL_REJECT_STREAMING_NACK
```
    Streaming NACK - peer accepted tunnel but can't deliver data
    See Also:
    Constant Field Values
  - TUNNEL_REJECT_TRANSIENT_OVERLOAD
```
public static final int TUNNEL_REJECT_TRANSIENT_OVERLOAD
```
    tunnel rejection due to temporary cpu/job/tunnel overload - rare
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelHistory
```
public TunnelHistory(RouterContext context,
                     String statGroup)
```
    TunnelHistory.
- Method Detail
  - coalesceStats
```
public void coalesceStats()
```
    coalesceStats.
  - getAcceptanceRatio
```
public double getAcceptanceRatio()
```
    Calculate the ratio of accepted to rejected tunnel requests.
    Returns:
    ratio (0.0 to 1.0), or 1.0 if no data available
  - getFailedRate
```
public RateStat getFailedRate()
```
    Returns:
    the failed rate
  - getLastAgreedTo
```
public long getLastAgreedTo()
```
    when the peer last agreed to participate in a tunnel
  - getLastFailed
```
public long getLastFailed()
```
    when the last tunnel the peer participated in failed
  - getLastRejectedBandwidth
```
public long getLastRejectedBandwidth()
```
    when the peer last refused to participate in a tunnel complaining of bandwidth overload
  - getLastRejectedCritical
```
public long getLastRejectedCritical()
```
    when the peer last refused to participate in a tunnel with level of critical
  - getLastRejectedProbabalistic
```
public long getLastRejectedProbabalistic()
```
    when the peer last refused to participate in a tunnel probabalistically
  - getLastRejectedTransient
```
public long getLastRejectedTransient()
```
    when the peer last refused to participate in a tunnel complaining of transient overload
  - getLastTestedSuccessfully
```
public long getLastTestedSuccessfully()
```
    when the peer last passed a tunnel test
  - getLifetimeAgreedTo
```
public long getLifetimeAgreedTo()
```
    total tunnels the peer has agreed to participate in
  - getLifetimeFailed
```
public long getLifetimeFailed()
```
    total tunnels the peer has agreed to participate in that were later marked as failed prematurely
  - getLifetimeRejected
```
public long getLifetimeRejected()
```
    total tunnels the peer has refused to participate in
  - getRejectionRate
```
public RateStat getRejectionRate()
```
    Returns:
    the rejection rate
  - incrementAgreedTo
```
public void incrementAgreedTo()
```
    incrementAgreedTo.
  - incrementFailed
```
public void incrementFailed(int pct)
```
    Define this rate as the probability it really failed
    Parameters:
    pct - = probability * 100
  - incrementProcessed
```
public void incrementProcessed(int processedSuccessfully,
                               int failedProcessing)
```
    incrementProcessed.
  - incrementRejected
```
public void incrementRejected(int severity)
```
    Parameters:
    severity - how much the peer doesnt want to participate in the tunnel (large == more severe)
  - incrementTestSucceeded
```
public void incrementTestSucceeded()
```
    Record that a tunnel test through this peer succeeded. This indicates the peer is actively participating in working tunnels.
  - load
```
public void load(Properties props)
```
    load.
  - store
```
public void store(OutputStream out)
           throws IOException
```
    store.
    Throws:
    IOException
  - store
```
public void store(OutputStream out,
                  boolean addComments)
           throws IOException
```
    write out the data from the profile to the stream
    Parameters:
    addComments - add comment lines to the output
    Throws:
    IOException

Class TunnelHistory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RATES

TUNNEL_REJECT_BANDWIDTH

TUNNEL_REJECT_CRIT

TUNNEL_REJECT_PROBABALISTIC_REJECT

TUNNEL_REJECT_STREAMING_NACK

TUNNEL_REJECT_TRANSIENT_OVERLOAD

Constructor Detail

TunnelHistory

Method Detail

coalesceStats

getAcceptanceRatio

getFailedRate

getLastAgreedTo

getLastFailed

getLastRejectedBandwidth

getLastRejectedCritical

getLastRejectedProbabalistic

getLastRejectedTransient

getLastTestedSuccessfully

getLifetimeAgreedTo

getLifetimeFailed

getLifetimeRejected

getRejectionRate

incrementAgreedTo

incrementFailed

incrementProcessed

incrementRejected

incrementTestSucceeded

load

store

store