PooledTunnelCreatorConfig (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.tunnel.TunnelCreatorConfig
- - net.i2p.router.tunnel.pool.PooledTunnelCreatorConfig

All Implemented Interfaces:: TunnelInfo

public class PooledTunnelCreatorConfig
extends TunnelCreatorConfig

Data about a tunnel we created

Field Summary
- Fields inherited from class net.i2p.router.tunnel.TunnelCreatorConfig
  _context, MAX_CONSECUTIVE_TEST_FAILURES, REPLY_IV_LENGTH

Constructor Summary

Constructors
Constructor and Description
`PooledTunnelCreatorConfig(RouterContext ctx, int length, boolean isInbound, Hash destination, TunnelPool pool)` Creates a new instance of PooledTunnelCreatorConfig

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getLastActivity()`
`Properties`	`getOptions()` The tunnel pool options.
`TunnelId`	`getPairedGW()` The ID of the gateway of the paired tunnel used to send/receive the build request
`TunnelPool`	`getTunnelPool()`
`boolean`	`isBypassPacing()`
`boolean`	`isLastResort()`
`boolean`	`isRecentlyActive()`
`void`	`recordActivity()` Record activity on this tunnel (message processed).
`void`	`setBypassPacing()` Mark this build as emergency recovery: it must be sent even if the first-hop peer already has a build in flight.
`void`	`setLastResort()` Mark this tunnel as a last-resort fallback.
`void`	`setPairedGW(TunnelId gw)` The ID of the gateway of the paired tunnel used to send/receive the build request
`void`	`testJobSuccessful(int ms)` Called from TestJob.
`boolean`	`tunnelFailed()` The tunnel failed a test, so (maybe) stop using it
`void`	`tunnelFailedFirstHop()` We failed to contact the first hop for an outbound tunnel, so immediately stop using it.

Methods inherited from class net.i2p.router.tunnel.TunnelCreatorConfig
addLatencySample, clearExpeditedTest, clearTestFailures, getAESReplyIV, getAESReplyKey, getAverageLatency, getBlankHash, getChaChaReplyAD, getChaChaReplyKey, getConfig, getConsecutiveFailures, getDestination, getDestinationNickname, getEndpoint, getExpiration, getFarEnd, getGarlicReplyKeys, getGateway, getLastLatency, getLastRealTraffic, getLastTransferred, getLength, getPeer, getPriority, getProcessedMessagesCount, getReceiveTunnelId, getRecentTestExemptions, getReplyMessageId, getReplyOrder, getSendTunnelId, getTestStatus, getTunnelFailed, getTunnelFailures, getVerifiedBytesTransferred, hasEnoughLatencyTests, incrementProcessedMessages, incrementRecentTestExemptions, incrementTestFailures, incrementVerifiedBytesTransferred, isEC, isInbound, needsExpeditedTest, recordRealTraffic, requestExpeditedTest, setAESReplyKeys, setBlankHash, setChaChaReplyKeys, setDestinationNickname, setExpiration, setGarlicReplyKeys, setLastLatency, setPeer, setPriority, setReplyMessageId, setReplyOrder, setReused, setTestFailed, setTestOverBudget, setTestStarted, setTestTooSlow, testSuccessful, toString, toStringFull, tunnelFailedCompletely, wasReused

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

- Constructor Detail
  - PooledTunnelCreatorConfig
```
public PooledTunnelCreatorConfig(RouterContext ctx,
                                 int length,
                                 boolean isInbound,
                                 Hash destination,
                                 TunnelPool pool)
```
    Creates a new instance of PooledTunnelCreatorConfig
    Parameters:
    destination - may be null
    pool - non-null
- Method Detail
  - getLastActivity
```
public long getLastActivity()
```
    Returns:
    timestamp of last activity, or 0 if never used
  - getOptions
```
public Properties getOptions()
```
    Description copied from class: TunnelCreatorConfig
    The tunnel pool options.
    Overrides:
    getOptions in class TunnelCreatorConfig
    Returns:
    non-null
  - getPairedGW
```
public TunnelId getPairedGW()
```
    The ID of the gateway of the paired tunnel used to send/receive the build request
    Returns:
    for paired inbound, the GW rcv tunnel ID; for paired outbound, the GW send tunnel ID. null if not previously set
  - getTunnelPool
```
public TunnelPool getTunnelPool()
```
    Returns:
    non-null
  - isBypassPacing
```
public boolean isBypassPacing()
```
    Returns:
    true if this build bypasses the per-peer in-flight guard in BuildExecutor.buildTunnel(net.i2p.router.tunnel.pool.PooledTunnelCreatorConfig)
  - isLastResort
```
public boolean isLastResort()
```
    Returns:
    true if this tunnel was built as a last-resort fallback
  - isRecentlyActive
```
public boolean isRecentlyActive()
```
    Returns:
    true if this tunnel has been recently active (within ACTIVITY_TIMEOUT)
  - recordActivity
```
public void recordActivity()
```
    Record activity on this tunnel (message processed).
  - setBypassPacing
```
public void setBypassPacing()
```
    Mark this build as emergency recovery: it must be sent even if the first-hop peer already has a build in flight. Set by the pool when it has zero usable tunnels and cannot wait for the guard to clear.
  - setLastResort
```
public void setLastResort()
```
    Mark this tunnel as a last-resort fallback.
  - setPairedGW
```
public void setPairedGW(TunnelId gw)
```
    The ID of the gateway of the paired tunnel used to send/receive the build request
    Parameters:
    gw - for paired inbound, the GW rcv tunnel ID; for paired outbound, the GW send tunnel ID.
  - testJobSuccessful
```
public void testJobSuccessful(int ms)
```
    Called from TestJob.
  - tunnelFailed
```
public boolean tunnelFailed()
```
    The tunnel failed a test, so (maybe) stop using it
    Overrides:
    tunnelFailed in class TunnelCreatorConfig
    Returns:
    false if we stopped using it, true if still ok
  - tunnelFailedFirstHop
```
public void tunnelFailedFirstHop()
```
    We failed to contact the first hop for an outbound tunnel, so immediately stop using it. For outbound non-zero-hop tunnels only.
    Overrides:
    tunnelFailedFirstHop in class TunnelCreatorConfig

Class PooledTunnelCreatorConfig

Field Summary

Fields inherited from class net.i2p.router.tunnel.TunnelCreatorConfig

Constructor Summary

Method Summary

Methods inherited from class net.i2p.router.tunnel.TunnelCreatorConfig

Methods inherited from class java.lang.Object

Constructor Detail

PooledTunnelCreatorConfig

Method Detail

getLastActivity

getOptions

getPairedGW

getTunnelPool

isBypassPacing

isLastResort

isRecentlyActive

recordActivity

setBypassPacing

setLastResort

setPairedGW

testJobSuccessful

tunnelFailed

tunnelFailedFirstHop