TunnelCreatorConfig (Javadocs [I2P+ 2.13.0+]

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

All Implemented Interfaces:
TunnelInfo
Direct Known Subclasses:
PooledTunnelCreatorConfig
```
public abstract class TunnelCreatorConfig
extends Object
implements TunnelInfo
```
Coordinate the info that the tunnel creator keeps track of, including what peers are in the tunnel and what their configuration is See PooledTunnelCreatorConfig for the non-abstract class

Field Summary

Fields
Modifier and Type	Field and Description
`protected RouterContext`	`_context` The router context.
`static int`	`MAX_CONSECUTIVE_TEST_FAILURES` Maximum consecutive test failures before the tunnel is retired.
`static int`	`REPLY_IV_LENGTH` IV length for `getAESReplyIV(int)`

Constructor Summary

Constructors
Constructor and Description
`TunnelCreatorConfig(RouterContext ctx, int length, boolean isInbound)` For exploratory only (null destination)
`TunnelCreatorConfig(RouterContext ctx, int length, boolean isInbound, Hash destination)` Allocates the hop configs and peer arrays for the given length.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLatencySample(int ms)` Add a latency sample from a test result.
`void`	`clearExpeditedTest()` Clear the expedited test flag after running the expedited test.
`void`	`clearTestFailures()` Reset the consecutive failure counter and mark the tunnel as GOOD.
`byte[]`	`getAESReplyIV(int hop)` IV used to encrypt the reply sent for the tunnel creation crypto.
`SessionKey`	`getAESReplyKey(int hop)` Key to encrypt the reply sent for the tunnel creation crypto.
`int`	`getAverageLatency()` The average latency of the last 3 tests.
`Hash`	`getBlankHash()` Checksum for blank record
`byte[]`	`getChaChaReplyAD(int hop)` The ECIES reply associated data for the given hop, or null.
`SessionKey`	`getChaChaReplyKey(int hop)` The ECIES reply key for the given hop, or null.
`HopConfig`	`getConfig(int hop)` Retrieve the config for the given hop.
`int`	`getConsecutiveFailures()` The number of consecutive test failures.
`Hash`	`getDestination()` If this is a client tunnel, what destination is it for?
`String`	`getDestinationNickname()` Pool nickname for this tunnel, or null if not set.
`Hash`	`getEndpoint()` For convenience
`long`	`getExpiration()` The tunnel expiration, in ms since the epoch.
`Hash`	`getFarEnd()` For convenience
`MessageWrapper.OneTimeSession`	`getGarlicReplyKeys()` ECIES short OBEP record only.
`Hash`	`getGateway()` For convenience
`int`	`getLastLatency()` The last recorded test latency.
`long`	`getLastRealTraffic()` When the tunnel last carried real traffic.
`long`	`getLastTransferred()` When we last sent or received data on this tunnel
`int`	`getLength()` How many hops are there in the tunnel? INCLUDING US.
`Properties`	`getOptions()` The tunnel pool options.
`Hash`	`getPeer(int hop)` Retrieve the peer at the given hop (the gateway is hop 0).
`int`	`getPriority()` Outbound message priority - for outbound tunnels only
`int`	`getProcessedMessagesCount()` The number of messages pumped through this tunnel.
`TunnelId`	`getReceiveTunnelId(int hop)` Retrieve the tunnelId that the given hop receives messages on.
`int`	`getRecentTestExemptions()` The number of recent-traffic test exemptions used.
`long`	`getReplyMessageId()` The message ID for the new style reply.
`List<Integer>`	`getReplyOrder()` Component ordering in the new style request.
`TunnelId`	`getSendTunnelId(int hop)` Retrieve the tunnelId that the given hop sends messages on.
`TunnelTestStatus`	`getTestStatus()` The current test status of this tunnel for UI display.
`boolean`	`getTunnelFailed()` Has the tunnel failed completely?
`int`	`getTunnelFailures()` The consecutive failure count.
`long`	`getVerifiedBytesTransferred()` The total verified bytes transferred on this tunnel.
`boolean`	`hasEnoughLatencyTests()` Whether at least 3 latency samples have been collected.
`void`	`incrementProcessedMessages()` Take note of a message being pumped through this tunnel.
`void`	`incrementRecentTestExemptions()` Increment the recent-traffic test exemption counter.
`void`	`incrementTestFailures()` Increment the failure count without triggering pool removal or reuse flag.
`void`	`incrementVerifiedBytesTransferred(int bytes)` This calls profile manager tunnelDataPushed1m() for each peer
`boolean`	`isEC(int hop)` Is it an ECIES hop?
`boolean`	`isInbound()` Is this an inbound tunnel?
`boolean`	`needsExpeditedTest()` Whether the tunnel needs an expedited test due to slow detection.
`void`	`recordRealTraffic()` Record that the tunnel carried real traffic.
`void`	`requestExpeditedTest()` The tunnel appeared slow, so flag it for an expedited test.
`void`	`setAESReplyKeys(int hop, SessionKey key, byte[] iv)` Key and IV to encrypt the reply sent for the tunnel creation crypto.
`void`	`setBlankHash(Hash h)` Checksum for blank record
`void`	`setChaChaReplyKeys(int hop, SessionKey key, byte[] ad)` The ECIES reply key and associated data for the given hop.
`void`	`setDestinationNickname(String name)` Optional display nickname for this tunnel (e.g.
`void`	`setExpiration(long when)` The tunnel expiration, in ms since the epoch.
`void`	`setGarlicReplyKeys(MessageWrapper.OneTimeSession keys)` ECIES short OBEP record only.
`void`	`setLastLatency(int ms)` The latency of the last completed test.
`void`	`setPeer(int hop, Hash peer)` The peer at the given hop.
`void`	`setPriority(int priority)` Outbound message priority - for outbound tunnels only
`void`	`setReplyMessageId(long id)` The message ID for the new style reply.
`void`	`setReplyOrder(List<Integer> order)` The component ordering for the new style request.
`void`	`setReused()` Note that we reused this tunnel
`void`	`setTestFailed()` Called when a test fails.
`void`	`setTestOverBudget()` Mark tunnel as scheduled for early expiry due to pool being over budget.
`void`	`setTestStarted()` Called when a test is started.
`void`	`setTestTooSlow()` Mark tunnel as scheduled for early expiry (pruned from pool).
`void`	`testSuccessful(int ms)` Mark the tunnel as GOOD, recording the latency of the successful test.
`String`	`toString()` Human-readable description of the tunnel, its peers, and its state.
`String`	`toStringFull()`
`boolean`	`tunnelFailed()` The tunnel failed a test, so (maybe) stop using it
`void`	`tunnelFailedCompletely()` The tunnel failed completely, so definitely stop using it
`void`	`tunnelFailedFirstHop()` We failed to contact the first hop for an outbound tunnel, so immediately stop using it.
`boolean`	`wasReused()` Did we reuse this tunnel?

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

- Field Detail
  - _context
```
protected final RouterContext _context
```
    The router context.
  - MAX_CONSECUTIVE_TEST_FAILURES
```
public static final int MAX_CONSECUTIVE_TEST_FAILURES
```
    Maximum consecutive test failures before the tunnel is retired.
    See Also:
    Constant Field Values
  - REPLY_IV_LENGTH
```
public static final int REPLY_IV_LENGTH
```
    IV length for getAESReplyIV(int)
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelCreatorConfig
```
public TunnelCreatorConfig(RouterContext ctx,
                           int length,
                           boolean isInbound)
```
    For exploratory only (null destination)
    Parameters:
    length - 1 minimum (0 hop is length 1)
  - TunnelCreatorConfig
```
public TunnelCreatorConfig(RouterContext ctx,
                           int length,
                           boolean isInbound,
                           Hash destination)
```
    Allocates the hop configs and peer arrays for the given length.
    Parameters:
    length - 1 minimum (0 hop is length 1)
    destination - null for exploratory
- Method Detail
  - addLatencySample
```
public void addLatencySample(int ms)
```
    Add a latency sample from a test result.
    Parameters:
    ms - latency in milliseconds
  - clearExpeditedTest
```
public void clearExpeditedTest()
```
    Clear the expedited test flag after running the expedited test.
  - clearTestFailures
```
public void clearTestFailures()
```
    Reset the consecutive failure counter and mark the tunnel as GOOD. Used when a data-carrying tunnel fails a test — the data proves it works, so the tunnel should remain selectable and avoid pruning.
  - getAESReplyIV
```
public byte[] getAESReplyIV(int hop)
```
    IV used to encrypt the reply sent for the tunnel creation crypto. Null for short build record.
    Returns:
    16 bytes or null
  - getAESReplyKey
```
public SessionKey getAESReplyKey(int hop)
```
    Key to encrypt the reply sent for the tunnel creation crypto. Null for short build record.
    Returns:
    key or null
    Throws:
    IllegalArgumentException - if iv not 16 bytes
  - getAverageLatency
```
public int getAverageLatency()
```
    The average latency of the last 3 tests.
    Returns:
    average latency in ms, or -1 if no tests yet
  - getBlankHash
```
public Hash getBlankHash()
```
    Checksum for blank record
    Returns:
    the blank hash
  - getChaChaReplyAD
```
public byte[] getChaChaReplyAD(int hop)
```
    The ECIES reply associated data for the given hop, or null.
    Returns:
    the cha cha reply a d
  - getChaChaReplyKey
```
public SessionKey getChaChaReplyKey(int hop)
```
    The ECIES reply key for the given hop, or null.
    Returns:
    the cha cha reply key
  - getConfig
```
public HopConfig getConfig(int hop)
```
    Retrieve the config for the given hop. the gateway is hop 0.
    Returns:
    the config
  - getConsecutiveFailures
```
public int getConsecutiveFailures()
```
    The number of consecutive test failures.
    Specified by:
    getConsecutiveFailures in interface TunnelInfo
    Returns:
    the count of consecutive failures
  - getDestination
```
public Hash getDestination()
```
    If this is a client tunnel, what destination is it for?
    Specified by:
    getDestination in interface TunnelInfo
    Returns:
    null for exploratory
  - getDestinationNickname
```
public String getDestinationNickname()
```
    Pool nickname for this tunnel, or null if not set.
    Returns:
    the pool nickname if set, null otherwise
  - getEndpoint
```
public Hash getEndpoint()
```
    For convenience
    Specified by:
    getEndpoint in interface TunnelInfo
    Returns:
    getPeer(getLength() - 1)
  - getExpiration
```
public long getExpiration()
```
    The tunnel expiration, in ms since the epoch.
    Specified by:
    getExpiration in interface TunnelInfo
    Returns:
    the expiration
  - getFarEnd
```
public Hash getFarEnd()
```
    For convenience
    Specified by:
    getFarEnd in interface TunnelInfo
    Returns:
    isInbound() ? getGateway() : getEndpoint()
  - getGarlicReplyKeys
```
public MessageWrapper.OneTimeSession getGarlicReplyKeys()
```
    ECIES short OBEP record only.
    Returns:
    null for ElGamal or ECIES long record or non-OBEP
  - getGateway
```
public Hash getGateway()
```
    For convenience
    Specified by:
    getGateway in interface TunnelInfo
    Returns:
    getPeer(0)
  - getLastLatency
```
public int getLastLatency()
```
    The last recorded test latency.
    Specified by:
    getLastLatency in interface TunnelInfo
    Returns:
    latency in milliseconds, or -1 if not available
  - getLastRealTraffic
```
public long getLastRealTraffic()
```
    When the tunnel last carried real traffic.
    Specified by:
    getLastRealTraffic in interface TunnelInfo
    Returns:
    the timestamp, or 0 if it never carried real traffic
  - getLastTransferred
```
public long getLastTransferred()
```
    When we last sent or received data on this tunnel
    Returns:
    the last transferred
  - getLength
```
public int getLength()
```
    How many hops are there in the tunnel? INCLUDING US. i.e. one more than the TunnelCreatorConfig length.
    Specified by:
    getLength in interface TunnelInfo
    Returns:
    the length
  - getOptions
```
public Properties getOptions()
```
    The tunnel pool options.
    Returns:
    the options
  - getPeer
```
public Hash getPeer(int hop)
```
    Retrieve the peer at the given hop (the gateway is hop 0).
    Specified by:
    getPeer in interface TunnelInfo
  - getPriority
```
public int getPriority()
```
    Outbound message priority - for outbound tunnels only
    Returns:
    -25 to +25, default 0
  - getProcessedMessagesCount
```
public int getProcessedMessagesCount()
```
    The number of messages pumped through this tunnel.
    Specified by:
    getProcessedMessagesCount in interface TunnelInfo
    Returns:
    the processed messages count
  - getReceiveTunnelId
```
public TunnelId getReceiveTunnelId(int hop)
```
    Retrieve the tunnelId that the given hop receives messages on. the gateway is hop 0.
    Specified by:
    getReceiveTunnelId in interface TunnelInfo
    Returns:
    the receive tunnel id
  - getRecentTestExemptions
```
public int getRecentTestExemptions()
```
    The number of recent-traffic test exemptions used.
    Returns:
    the recent test exemptions
  - getReplyMessageId
```
public long getReplyMessageId()
```
    The message ID for the new style reply.
  - getReplyOrder
```
public List<Integer> getReplyOrder()
```
    Component ordering in the new style request.
  - getSendTunnelId
```
public TunnelId getSendTunnelId(int hop)
```
    Retrieve the tunnelId that the given hop sends messages on. the gateway is hop 0.
    Specified by:
    getSendTunnelId in interface TunnelInfo
    Returns:
    the send tunnel id
  - getTestStatus
```
public TunnelTestStatus getTestStatus()
```
    The current test status of this tunnel for UI display.
    Specified by:
    getTestStatus in interface TunnelInfo
    Returns:
    the current test status (UNTESTED, TESTING, GOOD, FAILING, or FAILED)
  - getTunnelFailed
```
public boolean getTunnelFailed()
```
    Has the tunnel failed completely?
    Specified by:
    getTunnelFailed in interface TunnelInfo
    Returns:
    the tunnel failed
  - getTunnelFailures
```
public int getTunnelFailures()
```
    The consecutive failure count.
    Returns:
    the tunnel failures
  - getVerifiedBytesTransferred
```
public long getVerifiedBytesTransferred()
```
    The total verified bytes transferred on this tunnel.
    Specified by:
    getVerifiedBytesTransferred in interface TunnelInfo
    Returns:
    the verified bytes transferred
  - hasEnoughLatencyTests
```
public boolean hasEnoughLatencyTests()
```
    Whether at least 3 latency samples have been collected.
    Returns:
    true if we have at least 3 latency samples
  - incrementProcessedMessages
```
public void incrementProcessedMessages()
```
    Take note of a message being pumped through this tunnel.
  - incrementRecentTestExemptions
```
public void incrementRecentTestExemptions()
```
    Increment the recent-traffic test exemption counter.
  - incrementTestFailures
```
public void incrementTestFailures()
```
    Increment the failure count without triggering pool removal or reuse flag. Used when a previously GOOD tunnel fails a retest — we want to track the failure for selection deprioritization but keep the tunnel alive for further testing and data delivery.
  - incrementVerifiedBytesTransferred
```
public void incrementVerifiedBytesTransferred(int bytes)
```
    This calls profile manager tunnelDataPushed1m() for each peer
    Specified by:
    incrementVerifiedBytesTransferred in interface TunnelInfo
    Parameters:
    bytes - the number of bytes to add to the verified total
  - isEC
```
public boolean isEC(int hop)
```
    Is it an ECIES hop?
    Returns:
    whether e c
  - isInbound
```
public boolean isInbound()
```
    Is this an inbound tunnel?
    Specified by:
    isInbound in interface TunnelInfo
  - needsExpeditedTest
```
public boolean needsExpeditedTest()
```
    Whether the tunnel needs an expedited test due to slow detection.
    Returns:
    true if tunnel needs an expedited test due to slow detection
  - recordRealTraffic
```
public void recordRealTraffic()
```
    Record that the tunnel carried real traffic.
    Specified by:
    recordRealTraffic in interface TunnelInfo
  - requestExpeditedTest
```
public void requestExpeditedTest()
```
    The tunnel appeared slow, so flag it for an expedited test.
  - setAESReplyKeys
```
public void setAESReplyKeys(int hop,
                            SessionKey key,
                            byte[] iv)
```
    Key and IV to encrypt the reply sent for the tunnel creation crypto.
    Throws:
    IllegalArgumentException - if iv not 16 bytes
  - setBlankHash
```
public void setBlankHash(Hash h)
```
    Checksum for blank record
  - setChaChaReplyKeys
```
public void setChaChaReplyKeys(int hop,
                               SessionKey key,
                               byte[] ad)
```
    The ECIES reply key and associated data for the given hop.
  - setDestinationNickname
```
public void setDestinationNickname(String name)
```
    Optional display nickname for this tunnel (e.g. pool name like I2PSnark)
  - setExpiration
```
public void setExpiration(long when)
```
    The tunnel expiration, in ms since the epoch.
    Specified by:
    setExpiration in interface TunnelInfo
    Parameters:
    when - expiration time in milliseconds since epoch
  - setGarlicReplyKeys
```
public void setGarlicReplyKeys(MessageWrapper.OneTimeSession keys)
```
    ECIES short OBEP record only.
  - setLastLatency
```
public void setLastLatency(int ms)
```
    The latency of the last completed test.
    Parameters:
    ms - latency in milliseconds
  - setPeer
```
public void setPeer(int hop,
                    Hash peer)
```
    The peer at the given hop.
  - setPriority
```
public void setPriority(int priority)
```
    Outbound message priority - for outbound tunnels only
    Parameters:
    priority - -25 to +25, default 0
  - setReplyMessageId
```
public void setReplyMessageId(long id)
```
    The message ID for the new style reply.
  - setReplyOrder
```
public void setReplyOrder(List<Integer> order)
```
    The component ordering for the new style request.
  - setReused
```
public void setReused()
```
    Note that we reused this tunnel
    Specified by:
    setReused in interface TunnelInfo
  - setTestFailed
```
public void setTestFailed()
```
    Called when a test fails. Updates the test status based on consecutive failure count. Only mark as FAILED after MAX_CONSECUTIVE_TEST_FAILURES (3) failures - before that, it's just FAILING and still counts as a valid tunnel.
    Specified by:
    setTestFailed in interface TunnelInfo
  - setTestOverBudget
```
public void setTestOverBudget()
```
    Mark tunnel as scheduled for early expiry due to pool being over budget.
  - setTestStarted
```
public void setTestStarted()
```
    Called when a test is started.
    Specified by:
    setTestStarted in interface TunnelInfo
  - setTestTooSlow
```
public void setTestTooSlow()
```
    Mark tunnel as scheduled for early expiry (pruned from pool).
  - testSuccessful
```
public void testSuccessful(int ms)
```
    Mark the tunnel as GOOD, recording the latency of the successful test.
    Specified by:
    testSuccessful in interface TunnelInfo
    Parameters:
    ms - the response time in milliseconds
  - toString
```
public String toString()
```
    Human-readable description of the tunnel, its peers, and its state.
    Overrides:
    toString in class Object
  - toStringFull
```
public String toStringFull()
```
  - tunnelFailed
```
public boolean tunnelFailed()
```
    The tunnel failed a test, so (maybe) stop using it
    Returns:
    false if we stopped using it, true if still ok
  - tunnelFailedCompletely
```
public void tunnelFailedCompletely()
```
    The tunnel failed completely, so definitely stop using it
  - 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.
    Base hook: marks the tunnel as failed. Subclasses with a pool (PooledTunnelCreatorConfig) also notify the pool of the failure.
  - wasReused
```
public boolean wasReused()
```
    Did we reuse this tunnel?
    Specified by:
    wasReused in interface TunnelInfo

Class TunnelCreatorConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_context

MAX_CONSECUTIVE_TEST_FAILURES

REPLY_IV_LENGTH

Constructor Detail

TunnelCreatorConfig

TunnelCreatorConfig

Method Detail

addLatencySample

clearExpeditedTest

clearTestFailures

getAESReplyIV

getAESReplyKey

getAverageLatency

getBlankHash

getChaChaReplyAD

getChaChaReplyKey

getConfig

getConsecutiveFailures

getDestination

getDestinationNickname

getEndpoint

getExpiration

getFarEnd

getGarlicReplyKeys

getGateway

getLastLatency

getLastRealTraffic

getLastTransferred

getLength

getOptions

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

tunnelFailed

tunnelFailedCompletely

tunnelFailedFirstHop