PeerProfile (Javadocs [I2P+ 2.13.0+]

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

```
public class PeerProfile
extends Object
```
Copied from http://www.i2p2.i2p/how_peerselection.html See also main() below for additional commentary by zzz. Currently, there is no 'ejection' strategy to get rid of the profiles for peers that are no longer active (or when the network consists of thousands of peers, to get rid of peers that are performing poorly). However, the size of each profile is fairly small, and is unrelated to how much data is collected about the peer, so that a router can keep a few thousand active peer profiles before the overhead becomes a serious concern. Once it becomes necessary, we can simply compact the poorly performing profiles (keeping only the most basic data) and maintain hundreds of thousands of profiles in memory. Beyond that size, we can simply eject the peers (e.g. keeping the best 100,000). TODO most of the methods should be synchronized.

Constructor Summary
Constructors
Constructor and Description
PeerProfile(RouterContext context, Hash peer)
Caller should call setLastHeardAbout() and setFirstHeardAbout()

Constructors
Constructor and Description
`PeerProfile(RouterContext context, Hash peer)` Caller should call setLastHeardAbout() and setFirstHeardAbout()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) void`	`coalesceOnly(boolean shouldDecay)` Caller must next call updateValues().
`void`	`coalesceStats()` Coalesce all stats and update values
`(package private) void`	`dataPushed(int size)` Record data pushed through this peer.
`(package private) void`	`dataPushed1m(int size)` The tunnel pushed that much data in a 1 minute period.
`boolean`	`equals(Object obj)`
`void`	`expandDBProfile()` For floodfills
`void`	`expandProfile()` When the given peer is performing well enough that we want to keep detailed stats on them again, call this to set up the info we dropped during shrinkProfile.
`int`	`getCapacityBonus()` extra factor added to the capacity ranking - this can be updated in the profile written to disk to affect how the algorithm ranks capacity.
`(package private) long`	`getCapacityBonusLastUpdate()`
`(package private) int`	`getCapacityBonusRaw()`
`float`	`getCapacityValue()` How many tunnels do we think this peer can handle over the next hour?
`(package private) RouterContext`	`getContext()` Helper for calculators.
`DBHistory`	`getDBHistory()` History of DB activity with the peer.
`RateStat`	`getDbIntroduction()` How many new peers we get from dbSearchReplyMessages or dbStore messages.
`RateStat`	`getDbResponseTime()` How long it takes to get a DB response from the peer (in milliseconds).
`long`	`getFirstHeardAbout()` When did we first hear about this peer?
`int`	`getIntegrationBonus()` extra factor added to the integration ranking - this can be updated in the profile written to disk to affect how the algorithm ranks integration.
`float`	`getIntegrationValue()` How well integrated into the network is this peer (as measured by how much they've told us that we didn't already know).
`boolean`	`getIsActive()` Is this peer active at the moment (sending/receiving messages within the last 10 minutes)
`boolean`	`getIsActive(long now)` Is this peer active at the moment (sending/receiving messages within the last 10 minutes)
`boolean`	`getIsActive(long period, long now)` Is this peer active at the moment (sending/receiving messages within the given period?) Also mark active if it is connected, as this will tend to encourage use of already-connected peers.
`boolean`	`getIsExpanded()` Whether the tunnel profile data has been allocated (RateStats, TunnelHistory).
`boolean`	`getIsExpandedDB()` Whether the DB profile data has been allocated.
`long`	`getLastHeardAbout()` when did we last hear about this peer?
`long`	`getLastHeardFrom()` When did we last hear from the peer?
`long`	`getLastSendFailed()` When did we last have a problem sending to this peer?
`long`	`getLastSendSuccessful()` When did we last send to this peer successfully?
`long`	`getLastTestedSuccessfully()` When the peer last passed a tunnel test successfully.
`long`	`getLastTestStarted()`
`(package private) long`	`getLastThroughputUpdate()`
`float`	`getPeakThroughputKBps()`
`float`	`getPeakTunnel1mThroughputKBps()` This is the speed value
`float`	`getPeakTunnelThroughputKBps()`
`Hash`	`getPeer()` what peer is being profiled
`float`	`getPeerTestTimeAverage()`
`int`	`getSpeedBonus()` Obsolete — prefer `isLowLatency()`.
`float`	`getSpeedValue()` How fast is the peer, taking into consideration both throughput and latency.
`double`	`getTunnelAcceptanceRatio()` Tunnel acceptance ratio from tunnel history.
`RateStat`	`getTunnelCreateResponseTime()` How long it takes to get a tunnel create response from the peer (in milliseconds).
`TunnelHistory`	`getTunnelHistory()` History of tunnel activity with the peer.
`float`	`getTunnelTestTimeAverage()`
`(package private) long`	`getTunnelTestTimeAvgLastUpdate()`
`(package private) int`	`getXORDistance()` For now, just a one-byte comparison
`int`	`hashCode()`
`(package private) boolean`	`isEstablished()` Is this peer established?
`boolean`	`isLowLatency()` Low latency flag, set when this peer has been observed to respond quickly to tunnel build requests.
`(package private) boolean`	`isSameCountry()` Is the peer in the same country as us?
`(package private) void`	`recalculateLowLatency()` Recalculate the low-latency flag from the accumulated peer test time average.
`void`	`setCapacityBonus(int bonus)`
`(package private) void`	`setCapacityBonusLastUpdate(long ts)`
`void`	`setDBHistory(DBHistory hist)` Set the DB history.
`(package private) void`	`setFirstHeardAbout(long when)` Set when did we first heard about this peer, only if older.
`void`	`setIntegrationBonus(int bonus)`
`void`	`setLastHeardAbout(long when)` Set when did we last hear about this peer, only if unset or newer.
`void`	`setLastHeardFrom(long when)` Set when we last heard from the peer.
`void`	`setLastSendFailed(long when)` Set when we last had a problem sending to this peer.
`void`	`setLastSendSuccessful(long when)` Set when we last sent to this peer successfully.
`(package private) void`	`setLastTestStarted(long ts)`
`(package private) void`	`setLastThroughputUpdate(long ts)`
`void`	`setLowLatency(boolean low)` Set the low latency flag.
`(package private) void`	`setPeakThroughputKBps(float kBps)` Only for restoration from persisted profile.
`(package private) void`	`setPeakTunnel1mThroughputKBps(float kBps)` Only for restoration from persisted profile.
`(package private) void`	`setPeakTunnelThroughputKBps(float kBps)` Only for restoration from persisted profile.
`(package private) void`	`setPeerTestTimeAverage(float testAvg)`
`void`	`setSpeedBonus(int bonus)` Obsolete — prefer `setLowLatency(boolean)`.
`void`	`setTunnelHistory(TunnelHistory history)` Set the tunnel history.
`(package private) void`	`setTunnelTestTimeAverage(float avg)` Set the tunnel test time average.
`(package private) void`	`setTunnelTestTimeAvgLastUpdate(long ts)` Set the timestamp of the last tunnel test time average update.
`void`	`shrinkDBProfile()` Shrink the DB-specific part of the profile.
`void`	`shrinkProfile()` Shrink the profile by dropping the RateStat objects.
`String`	`toString()`
`(package private) void`	`tunnelDataTransferred(long tunnelByteLifetime)` The tunnel pushed that much data in its lifetime.
`(package private) void`	`updatePeerTestTimeAverage(float ms)` Update peer test time average.
`(package private) void`	`updateTunnelTestTimeAverage(float ms)` Update the tunnel test time average with a new measurement.
`void`	`updateValues()` Update the speed, capacity, and integration values from the new values.
`boolean`	`wasUnreachable()` Was the peer previously unreachable?

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

- Constructor Detail
  - PeerProfile
```
public PeerProfile(RouterContext context,
                   Hash peer)
```
    Caller should call setLastHeardAbout() and setFirstHeardAbout()
    Parameters:
    context - the router context
    peer - non-null
- Method Detail
  - coalesceOnly
```
void coalesceOnly(boolean shouldDecay)
```
    Caller must next call updateValues().
    Parameters:
    shouldDecay - whether to decay peak throughput values
  - coalesceStats
```
public void coalesceStats()
```
    Coalesce all stats and update values
  - dataPushed
```
void dataPushed(int size)
```
    Record data pushed through this peer.
    Parameters:
    size - the number of bytes pushed
  - dataPushed1m
```
void dataPushed1m(int size)
```
    The tunnel pushed that much data in a 1 minute period.
    Parameters:
    size - the number of bytes in that minute
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    equals in class Object
  - expandDBProfile
```
public void expandDBProfile()
```
    For floodfills
  - expandProfile
```
public void expandProfile()
```
    When the given peer is performing well enough that we want to keep detailed stats on them again, call this to set up the info we dropped during shrinkProfile. This will not however overwrite any existing data, so it can be safely called repeatedly
  - getCapacityBonus
```
public int getCapacityBonus()
```
    extra factor added to the capacity ranking - this can be updated in the profile written to disk to affect how the algorithm ranks capacity. Negative values are penalties. Expires after 4 hours if not refreshed.
    Returns:
    the capacity bonus
  - getCapacityBonusLastUpdate
```
long getCapacityBonusLastUpdate()
```
    Returns:
    the timestamp of the last capacity bonus update
  - getCapacityBonusRaw
```
int getCapacityBonusRaw()
```
    Returns:
    the raw capacity bonus value
  - getCapacityValue
```
public float getCapacityValue()
```
    How many tunnels do we think this peer can handle over the next hour?
    Returns:
    the capacity value
  - getContext
```
RouterContext getContext()
```
    Helper for calculators.
    Returns:
    the router context
  - getDBHistory
```
public DBHistory getDBHistory()
```
    History of DB activity with the peer. Expands the DB profile lazily on first access.
    Returns:
    DBHistory, non-null after first access
  - getDbIntroduction
```
public RateStat getDbIntroduction()
```
    How many new peers we get from dbSearchReplyMessages or dbStore messages. Expands the DB profile lazily on first access.
    Returns:
    RateStat, non-null after first access
  - getDbResponseTime
```
public RateStat getDbResponseTime()
```
    How long it takes to get a DB response from the peer (in milliseconds). Expands the DB profile lazily on first access.
    Returns:
    RateStat, non-null after first access
  - getFirstHeardAbout
```
public long getFirstHeardAbout()
```
    When did we first hear about this peer?
    Returns:
    greater than zero, set to now in constructor
  - getIntegrationBonus
```
public int getIntegrationBonus()
```
    extra factor added to the integration ranking - this can be updated in the profile written to disk to affect how the algorithm ranks integration. Negative values are penalties.
    Returns:
    the integration bonus
  - getIntegrationValue
```
public float getIntegrationValue()
```
    How well integrated into the network is this peer (as measured by how much they've told us that we didn't already know). Higher numbers means better integrated.
    Returns:
    the integration value
  - getIsActive
```
public boolean getIsActive()
```
    Is this peer active at the moment (sending/receiving messages within the last 10 minutes)
    Returns:
    true if active
  - getIsActive
```
public boolean getIsActive(long now)
```
    Is this peer active at the moment (sending/receiving messages within the last 10 minutes)
    Parameters:
    now - current time
    Returns:
    true if active
  - getIsActive
```
public boolean getIsActive(long period,
                           long now)
```
    Is this peer active at the moment (sending/receiving messages within the given period?) Also mark active if it is connected, as this will tend to encourage use of already-connected peers.
    Parameters:
    period - must be one of the periods in the RateStat constructors below (5*60*1000 or 60*60*1000)
    now - current time
    Returns:
    true if active
  - getIsExpanded
```
public boolean getIsExpanded()
```
    Whether the tunnel profile data has been allocated (RateStats, TunnelHistory). Profiles are created unexpanded and expanded lazily on first use.
    Returns:
    true if expanded
  - getIsExpandedDB
```
public boolean getIsExpandedDB()
```
    Whether the DB profile data has been allocated.
    Returns:
    true if expanded DB
  - getLastHeardAbout
```
public long getLastHeardAbout()
```
    when did we last hear about this peer?
    Returns:
    0 if unset
  - getLastHeardFrom
```
public long getLastHeardFrom()
```
    When did we last hear from the peer?
    Returns:
    the timestamp
  - getLastSendFailed
```
public long getLastSendFailed()
```
    When did we last have a problem sending to this peer?
    Returns:
    the timestamp
  - getLastSendSuccessful
```
public long getLastSendSuccessful()
```
    When did we last send to this peer successfully?
    Returns:
    the timestamp
  - getLastTestedSuccessfully
```
public long getLastTestedSuccessfully()
```
    When the peer last passed a tunnel test successfully.
    Returns:
    timestamp, or 0 if never
  - getLastTestStarted
```
public long getLastTestStarted()
```
    Returns:
    the timestamp of the last test start
  - getLastThroughputUpdate
```
long getLastThroughputUpdate()
```
    Returns:
    the timestamp of the last throughput update
  - getPeakThroughputKBps
```
public float getPeakThroughputKBps()
```
    Returns:
    the peak throughput in KBps
  - getPeakTunnel1mThroughputKBps
```
public float getPeakTunnel1mThroughputKBps()
```
    This is the speed value
    Returns:
    the average of the three fastest one-minute data transfers, on a per-tunnel basis, through this peer. Ever. Except that the peak values are cut in half periodically by coalesceThroughput().
  - getPeakTunnelThroughputKBps
```
public float getPeakTunnelThroughputKBps()
```
    Returns:
    the peak tunnel throughput in KBps
  - getPeer
```
public Hash getPeer()
```
    what peer is being profiled
    Returns:
    the peer, non-null
  - getPeerTestTimeAverage
```
public float getPeerTestTimeAverage()
```
    Returns:
    the peer test time average
  - getSpeedBonus
```
public int getSpeedBonus()
```
    Obsolete — prefer isLowLatency(). Retained for backward compatibility with stored profile data. Returns 0 unconditionally if not set, or the stored value with a 4-hour expiry for existing profiles that still carry it.
    Returns:
    the speed bonus
  - getSpeedValue
```
public float getSpeedValue()
```
    How fast is the peer, taking into consideration both throughput and latency. This may even be made to take into consideration current rates vs. estimated (or measured) max rates, allowing this speed to reflect the speed /available/.
    Returns:
    the speed value
  - getTunnelAcceptanceRatio
```
public double getTunnelAcceptanceRatio()
```
    Tunnel acceptance ratio from tunnel history.
    Returns:
    ratio (0.0 to 1.0), or 1.0 if no data available
  - getTunnelCreateResponseTime
```
public RateStat getTunnelCreateResponseTime()
```
    How long it takes to get a tunnel create response from the peer (in milliseconds). Expands the profile lazily on first access.
    Returns:
    RateStat, non-null after first access
  - getTunnelHistory
```
public TunnelHistory getTunnelHistory()
```
    History of tunnel activity with the peer. Expands the profile lazily on first access.
    Returns:
    TunnelHistory, non-null after first access
  - getTunnelTestTimeAverage
```
public float getTunnelTestTimeAverage()
```
    Returns:
    EWMA average with time-based decay (50% per hour since last update)
  - getTunnelTestTimeAvgLastUpdate
```
long getTunnelTestTimeAvgLastUpdate()
```
    Returns:
    timestamp when the EWMA was last updated
  - getXORDistance
```
int getXORDistance()
```
    For now, just a one-byte comparison
    Returns:
    -127 to +128, lower is closer
  - hashCode
```
public int hashCode()
```
    Overrides:
    hashCode in class Object
  - isEstablished
```
boolean isEstablished()
```
    Is this peer established?
    Returns:
    true if established
  - isLowLatency
```
public boolean isLowLatency()
```
    Low latency flag, set when this peer has been observed to respond quickly to tunnel build requests. Persisted in profiles and used to seed fast/high-cap tiers at startup from prior session data.
    Returns:
    true if low latency
  - isSameCountry
```
boolean isSameCountry()
```
    Is the peer in the same country as us?
    Returns:
    true if same country
  - recalculateLowLatency
```
void recalculateLowLatency()
```
    Recalculate the low-latency flag from the accumulated peer test time average. Low latency is defined as an average response time under 3x the peer test timeout (default 750ms, so 2250ms threshold), matching the same threshold used in BuildExecutor. Called periodically to keep _lowLatency in sync with measured data.
  - setCapacityBonus
```
public void setCapacityBonus(int bonus)
```
    Parameters:
    bonus - the capacity bonus
  - setCapacityBonusLastUpdate
```
void setCapacityBonusLastUpdate(long ts)
```
    Parameters:
    ts - the timestamp
  - setDBHistory
```
public void setDBHistory(DBHistory hist)
```
    Set the DB history.
    Parameters:
    hist - the DBHistory
  - setFirstHeardAbout
```
void setFirstHeardAbout(long when)
```
    Set when did we first heard about this peer, only if older. Package private, only set by profile management subsystem.
    Parameters:
    when - the time to set
  - setIntegrationBonus
```
public void setIntegrationBonus(int bonus)
```
    Parameters:
    bonus - the integration bonus
  - setLastHeardAbout
```
public void setLastHeardAbout(long when)
```
    Set when did we last hear about this peer, only if unset or newer. Also sets FirstHeardAbout if earlier.
    Parameters:
    when - the time to set
  - setLastHeardFrom
```
public void setLastHeardFrom(long when)
```
    Set when we last heard from the peer.
    Parameters:
    when - the timestamp
  - setLastSendFailed
```
public void setLastSendFailed(long when)
```
    Set when we last had a problem sending to this peer.
    Parameters:
    when - the timestamp
  - setLastSendSuccessful
```
public void setLastSendSuccessful(long when)
```
    Set when we last sent to this peer successfully.
    Parameters:
    when - the timestamp
  - setLastTestStarted
```
void setLastTestStarted(long ts)
```
    Parameters:
    ts - the timestamp
  - setLastThroughputUpdate
```
void setLastThroughputUpdate(long ts)
```
    Parameters:
    ts - the timestamp
  - setLowLatency
```
public void setLowLatency(boolean low)
```
    Set the low latency flag.
    Parameters:
    low - true for low latency
  - setPeakThroughputKBps
```
void setPeakThroughputKBps(float kBps)
```
    Only for restoration from persisted profile.
    Parameters:
    kBps - the peak throughput in KBps
  - setPeakTunnel1mThroughputKBps
```
void setPeakTunnel1mThroughputKBps(float kBps)
```
    Only for restoration from persisted profile.
    Parameters:
    kBps - the peak 1-minute throughput in KBps
  - setPeakTunnelThroughputKBps
```
void setPeakTunnelThroughputKBps(float kBps)
```
    Only for restoration from persisted profile.
    Parameters:
    kBps - the peak tunnel throughput in KBps
  - setPeerTestTimeAverage
```
void setPeerTestTimeAverage(float testAvg)
```
    Parameters:
    testAvg - the peer test time average
  - setSpeedBonus
```
public void setSpeedBonus(int bonus)
```
    Obsolete — prefer setLowLatency(boolean). Retained for backward compatibility with stored profile data.
    Parameters:
    bonus - the speed bonus
  - setTunnelHistory
```
public void setTunnelHistory(TunnelHistory history)
```
    Set the tunnel history.
    Parameters:
    history - the TunnelHistory
  - setTunnelTestTimeAverage
```
void setTunnelTestTimeAverage(float avg)
```
    Set the tunnel test time average.
    Parameters:
    avg - the average in ms
  - setTunnelTestTimeAvgLastUpdate
```
void setTunnelTestTimeAvgLastUpdate(long ts)
```
    Set the timestamp of the last tunnel test time average update.
    Parameters:
    ts - the timestamp
  - shrinkDBProfile
```
public void shrinkDBProfile()
```
    Shrink the DB-specific part of the profile.
  - shrinkProfile
```
public void shrinkProfile()
```
    Shrink the profile by dropping the RateStat objects. They will be re-created lazily by expandProfile() when the profile is used again.
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object
  - tunnelDataTransferred
```
void tunnelDataTransferred(long tunnelByteLifetime)
```
    The tunnel pushed that much data in its lifetime.
    Parameters:
    tunnelByteLifetime - total bytes transferred
  - updatePeerTestTimeAverage
```
void updatePeerTestTimeAverage(float ms)
```
    Update peer test time average.
    Parameters:
    ms - the new measurement in ms
  - updateTunnelTestTimeAverage
```
void updateTunnelTestTimeAverage(float ms)
```
    Update the tunnel test time average with a new measurement.
    Parameters:
    ms - the new measurement in ms
  - updateValues
```
public void updateValues()
```
    Update the speed, capacity, and integration values from the new values.
  - wasUnreachable
```
public boolean wasUnreachable()
```
    Was the peer previously unreachable?
    Returns:
    true if unreachable

Class PeerProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PeerProfile

Method Detail

coalesceOnly

coalesceStats

dataPushed

dataPushed1m

equals

expandDBProfile

expandProfile

getCapacityBonus

getCapacityBonusLastUpdate

getCapacityBonusRaw

getCapacityValue

getContext

getDBHistory

getDbIntroduction

getDbResponseTime

getFirstHeardAbout

getIntegrationBonus

getIntegrationValue

getIsActive

getIsActive

getIsActive

getIsExpanded

getIsExpandedDB

getLastHeardAbout

getLastHeardFrom

getLastSendFailed

getLastSendSuccessful

getLastTestedSuccessfully

getLastTestStarted

getLastThroughputUpdate

getPeakThroughputKBps

getPeakTunnel1mThroughputKBps

getPeakTunnelThroughputKBps

getPeer

getPeerTestTimeAverage

getSpeedBonus

getSpeedValue

getTunnelAcceptanceRatio

getTunnelCreateResponseTime

getTunnelHistory

getTunnelTestTimeAverage

getTunnelTestTimeAvgLastUpdate

getXORDistance

hashCode

isEstablished

isLowLatency

isSameCountry

recalculateLowLatency

setCapacityBonus

setCapacityBonusLastUpdate

setDBHistory

setFirstHeardAbout

setIntegrationBonus

setLastHeardAbout

setLastHeardFrom

setLastSendFailed

setLastSendSuccessful

setLastTestStarted

setLastThroughputUpdate

setLowLatency

setPeakThroughputKBps

setPeakTunnel1mThroughputKBps

setPeakTunnelThroughputKBps

setPeerTestTimeAverage

setSpeedBonus

setTunnelHistory

setTunnelTestTimeAverage

setTunnelTestTimeAvgLastUpdate

shrinkDBProfile

shrinkProfile

toString

tunnelDataTransferred

updatePeerTestTimeAverage