AliasedTunnelPool

java.lang.Object

net.i2p.router.tunnel.pool.TunnelPool

net.i2p.router.tunnel.pool.AliasedTunnelPool

public class AliasedTunnelPoolextends TunnelPool

A tunnel pool with its own settings and Destination, but uses another pool for its tunnels.

Nested Class Summary
Nested classes/interfaces inherited from class TunnelPool
TunnelPool.LeaseComparator, TunnelPool.PoolState, TunnelPool.SessionLoss
Modifier and Type
Class
Description
(package private) static class
TunnelPool.LeaseComparator
Always build a LeaseSet with Leases in sorted order, so that LeaseSet.equals(Object) and lease-by-lease equals() always work.
(package private) static final class
TunnelPool.PoolState
Why a pool could not supply a tunnel, as counts rather than prose.
(package private) static enum
TunnelPool.SessionLoss
Why a tunnel's local transport session was lost.
Field Summary
Fields
Modifier and Type
Field
Description
private final TunnelPool
_aliasOf
The pool this one is a handle on.
Fields inherited from class TunnelPool
_alive, _context, _log, DEFAULT_PRUNE_EARLY_EXPIRY, FAST_TEST_AVG_MS, LAST_CHANCE_MIN_LIFE_MS, MAX_ADAPTIVE_TEST_MULTIPLIER, MAX_BUILD_PER_POOL_DIR, MAX_INPROGRESS_PER_POOL_DIR, MAX_LAST_CHANCE_PER_SWEEP, MAX_PRE_BUILD_WINDOW_MS, MAX_TUNNEL_LIFETIME_MS, PRE_BUILD_WINDOW_MS, PRE_EMERGENCY_BURST, PRE_EMERGENCY_FRACTION, QUALITY_COMPARATOR, SERVICE_POOL_PRIORITY, SLOW_TEST_AVG_MS, SOFT_DEGRADED_FOR_ENSURE, SOFT_REMOVAL_THRESHOLD, SPARE_HIGH_THRESHOLD, SPARE_LOW_THRESHOLD, ZOMBIE_STAT_HEALTHY, ZOMBIE_STAT_USABLE
Modifier and Type
Field
Description
protected boolean
_alive
Whether this pool is running.
protected final RouterContext
_context
The router context.
protected final Log
_log
The log.
(package private) static final long
DEFAULT_PRUNE_EARLY_EXPIRY
Default early expiration time for pruned tunnels (120 seconds).
(package private) static final long
FAST_TEST_AVG_MS
Rolling average test duration below which the test window is narrowed.
(package private) static final long
LAST_CHANCE_MIN_LIFE_MS
Minimum remaining life for a stale UNTESTED tunnel to be worth one last-chance test before pruning: a test needs a minute of runway for the request/reply round trip (plus the test itself) before the tunnel expires anyway.
(package private) static final double
MAX_ADAPTIVE_TEST_MULTIPLIER
Hard ceiling on the adaptive test timeout multiplier.
(package private) static final int
MAX_BUILD_PER_POOL_DIR
Hard cap on concurrent builds per pool direction in normal operation.
(package private) static final int
MAX_INPROGRESS_PER_POOL_DIR
Absolute ceiling on builds in flight per pool and direction, applied to every build path including the pre-emergency burst.
(package private) static final int
MAX_LAST_CHANCE_PER_SWEEP
Cap on last-chance tests enqueued per sweep pass — the global test caps still apply, but an explicit small bound keeps a fully-UNTESTED pool from flooding the first-test buffer in one ensure cycle.
(package private) static final long
MAX_PRE_BUILD_WINDOW_MS
Cap on the failure-scaled pre-build window — beyond this, starting earlier would keep nearly the whole pool's lifetime in build mode.
(package private) static final long
MAX_TUNNEL_LIFETIME_MS
Hard ceiling on TunnelPool.getTunnelLifetime(RouterContext): the standard 10m lifetime plus the 1m grace period other routers afford.
(package private) static final long
PRE_BUILD_WINDOW_MS
Base pre-build window: start replacements this long before existing tunnels expire so fresh builds (10-40s) complete before the old tunnels die.
(package private) static final int
PRE_EMERGENCY_BURST
Builds started in one pre-emergency burst.
(package private) static final double
PRE_EMERGENCY_FRACTION
Pre-emergency threshold: fraction of target below which builds start immediately.
(package private) static final Comparator<TunnelInfo>
QUALITY_COMPARATOR
Best tunnels first for LeaseSet publication: freshest (longest remaining life) so the lease survives floodfill propagation, then lowest average latency, then fewest consecutive failures.
(package private) static final double
SERVICE_POOL_PRIORITY
Priority weight for service pool builds.
(package private) static final long
SLOW_TEST_AVG_MS
Rolling average test duration above which the test window is widened.
(package private) static final int
SOFT_DEGRADED_FOR_ENSURE
Soft-failure count at which a still-usable tunnel is treated as degraded for ensure-throttle and deficit purposes.
(package private) static final int
SOFT_REMOVAL_THRESHOLD
Higher removal bar for soft best-effort send timeouts (status 3).
(package private) static final int
SPARE_HIGH_THRESHOLD
Consecutive build timeouts at which the spare grows to two tunnels.
(package private) static final int
SPARE_LOW_THRESHOLD
Consecutive build timeouts at which the pool starts holding one spare tunnel above target (see TunnelPool.computeDifficultySpare(int)).
(package private) static final String
ZOMBIE_STAT_HEALTHY
Rate stat recording how many tunnels TunnelPool.getHealthyTunnelCount() dropped for want of a transport session to their local hop.
(package private) static final String
ZOMBIE_STAT_USABLE
Rate stat recording how many tunnels TunnelPool.getUsableTunnelCount() dropped for the same reason.
Constructor Summary
Constructors
Constructor
Description
AliasedTunnelPool(RouterContext ctx, TunnelPoolManager mgr, TunnelPoolSettings settings, TunnelPool aliasOf)
Create an aliased tunnel pool.
Method Summary
Public Methods
Modifier and Type
Method
Description
protected void
addTunnel(TunnelInfo info)
Add a tunnel to the pool.
(package private) void
buildComplete(PooledTunnelCreatorConfig cfg, BuildExecutor.Result result)
Remove from the _inprogress list and call addTunnel() if result is SUCCESS.
(package private) boolean
buildFallback()
This will build a fallback (zero-hop) tunnel ONLY if this pool is exploratory, or the settings allow it.
(package private) PooledTunnelCreatorConfig
configureNewTunnel()
This only sets the peers and creation/expiration times in the configuration.
(package private) void
ensureSufficientTunnels()
Aliased pools have no tunnels of their own; the primary pool builds and maintains tunnels for all aliases.
long
getLifetimeProcessed()
Total lifetime processed bytes for this pool.
TunnelInfo
getTunnel(TunnelId gatewayId)
Tunnel by its gateway tunnel ID.
boolean
isAlive()
Is this pool running AND either exploratory, or tracked by the client manager? A pool will be alive but not tracked after the client manager removes it but before all the tunnels have expired.
List<PooledTunnelCreatorConfig>
listPending()
List of tunnelInfo instances of tunnels currently being built.
List<TunnelInfo>
listTunnels()
List of tunnels currently in the pool.
protected LeaseSet
locked_buildNewLeaseSet()
Build a leaseSet with the required tunnels that aren't about to expire.
(package private) boolean
needFallback()
Do we really need more fallbacks? Used to prevent a zillion of them.
(package private) void
refreshLeaseSet()
No-op for outbound and exploratory pools.
void
refreshLeaseSet(boolean force)
Refresh the LeaseSet, throttled to prevent flooding but not on initial creation.
(package private) void
removeTunnel(TunnelInfo info)
Remove a tunnel from the pool.
(package private) TunnelInfo
selectTunnel()
Pull a random tunnel out of the pool.
(package private) TunnelInfo
selectTunnel(Hash closestTo)
Return the tunnel from the pool that is XOR-closest to the target.
(package private) void
shutdown()
Shut down the pool and clean up resources.
int
size()
Count every tunnel in the pool, including failed and expired ones awaiting cleanup.
(package private) void
startup()
Warning, this may be called more than once (without an intervening shutdown()) if the tunnel is stopped and then restarted by the client manager with the same Destination (i.e.
String
toString()
Description of the pool and its settings.
(package private) void
tunnelFailed(TunnelInfo cfg)
Remove tunnel and blame all peers (not necessarily equally).
(package private) void
tunnelFailed(TunnelInfo cfg, Hash blamePeer)
Remove the tunnel and blame only one peer.
Methods inherited from class TunnelPool
alreadyCondemned, buildBootstrapTunnels, buildLeases, cancelExcessInProgress, classifyPoolState, classifySessionLoss, clearFailingOnTraffic, clearLeaseSurge, computeDeficit, computeDifficultySpare, computeLeaseEndDate, computePreBuildWindowMs, configureNewTunnel, countLeaseViableTunnels, countZeroHopFallbacks, exceedsRemovalThreshold, exceedsRemovalThreshold, exceedsSoftRemovalThreshold, findReusableCandidate, forceTunnelFailure, formatPoolIdentity, getActiveTunnelCount, getAdaptiveAvgTestDuration, getAdaptiveTestTimeout, getAvgBWPerTunnel, getBuildTriesQuantityOverride, getConsecutiveBuildTimeouts, getDifficultySpare, getEffectiveTarget, getHealthyTunnelCount, getInboundTunnelsAsLeaseSet, getInProgressCount, getLeaseMaxDuration, getLeaseSetBuildMinInterval, getLeaseSurgeNeed, getLeaseViabilityWindow, getMaxConcurrentBuildsPerDirection, getNearExpiryCount, getPairedPool, getPruneEarlyExpiry, getPruneEarlyExpiry, getRateName, getRefreshThrottle, getReplacementTunnelBuffer, getSettings, getStartupTime, getTestingTunnelCount, getTunnelAvgLatency, getTunnelLifetime, getTunnelPoolManager, getUsableTunnelCount, getValidTunnelCount, hasValidTunnelsBlockingEmergency, hasZeroHopFallback, incrementBuildTimeout, isDeficitThrottled, isDeficitThrottled, isEmergencyCooldownActive, isEnsureThrottled, isEnsureThrottled, isEnsureThrottled, isEnsureThrottled, isExpiringSoon, isLastChanceTestable, isMateriallyShort, isPreEmergencyBurstLive, isPreEmergencyExempt, isSoftDegraded, isSoftSendFailure, isStruggling, isTrafficProvenUntestedLeaseCandidate, leaseSurgeCandidates, maxExpirationStagger, noPeersSelectedLine, notifyServerPoolTestFailed, partnerPreferenceTier, passesScanGates, proactiveRepublishIfHealthy, pruneExcessTunnels, removeInProgress, removeTunnelSynchronous, reportSendFailure, requestFreshTunnelBuild, requestLeaseSurge, rotateWindowStart, selectTunnelForTest, setPairedPool, setSettings, shouldBypassEnsureThrottle, shouldDeferMissingPublished, shouldDeferPublishedRefresh, shouldDropForLostSession, shouldLogSendFailure, shouldSkipAsyncPublish, shouldWarnSelectPeersFailure, softRemovalThreshold, stampLostSession, timeoutRate, tunnelFailedWithoutBlame, updateAdaptiveTestDuration, updatedAdaptiveTestMultiplier, updatedAvgTestDuration, usableLeaseMinimum, zombieTransportBucket
Modifier and Type
Method
Description
(package private) static boolean
alreadyCondemned(boolean isDead, TunnelTestStatus status)
Whether a failure report is a repeat of a condemnation already made.
(package private) boolean
buildBootstrapTunnels()
Build bootstrap tunnels for exploratory pools during cold start.
(package private) TreeSet<Lease>
buildLeases(List<TunnelInfo> goodTunnels, TunnelInfo zeroHopTunnel)
Assemble the Lease objects for the selected tunnels: the single zero-hop lease (if any), then the quality-sorted GOOD tunnels.
List<PooledTunnelCreatorConfig>
cancelExcessInProgress(int maxAllowed)
Cancel excess in-progress tunnel builds to stay within budget.
(package private) static TunnelPool.PoolState
classifyPoolState(List<TunnelInfo> tunnels, long now, java.util.function.Predicate<TunnelInfo> backlogged)
Count the pool by selection outcome.
(package private) static TunnelPool.SessionLoss
classifySessionLoss(boolean hadSessionAtBuild, boolean establishedNow, boolean peerReachable)
Attribute a lost local transport session to our side or the peer's.
void
clearFailingOnTraffic()
Clear FAILING/FAILED flags on tunnels that have provably carried real traffic recently.
void
clearLeaseSurge()
Drop any lease-material prune override.
(package private) static int
computeDeficit(int healthySafe, int safeActive, int softDegraded, int failingCount, int untestedCount, int target, int effectiveTarget, int currentInProgress)
Pure deficit calculation so unit tests can pin the soft-degraded occupancy rules without a router context.
(package private) static int
computeDifficultySpare(int consecutiveBuildTimeouts)
Spare tunnels held above target while the pool is having difficulty building.
(package private) static long
computeLeaseEndDate(long tunnelExpiration, long now, long maxLeaseMs)
Compute the end date advertised for a lease, given the tunnel's own expiration.
(package private) static long
computePreBuildWindowMs(double rate)
How far ahead of expiry to start building replacements, scaled by how badly this pool's builds are failing: a pool with a high build-timeout rate needs more lead time because each attempt may burn a full timeout (17-30s) before the next one starts.
(package private) PooledTunnelCreatorConfig
configureNewTunnel(boolean forceZeroHop, Set<Hash> excludeFirstHops)
Configure a new tunnel, optionally excluding peers from first-hop selection.
(package private) static int
countLeaseViableTunnels(List<TunnelInfo> tunnels, List<TunnelInfo> toRemove, long now)
How many tunnels could still be advertised right now, on the same bar selectLeaseTunnels applies, matching the wording of the sibling prune path.
(package private) int
countZeroHopFallbacks()
Count the zero-hop fallback tunnels in this pool.
(package private) static boolean
exceedsRemovalThreshold(int failures)
Whether cumulative data-phase and TestJob failures exceed the removal threshold.
(package private) static boolean
exceedsRemovalThreshold(int failures, boolean soft)
Whether the given failure class exceeds its marking bar.
static boolean
exceedsSoftRemovalThreshold(int failures)
Whether a soft failure count crosses the soft marking bar.
(package private) static TunnelInfo
findReusableCandidate(List<TunnelInfo> tunnels, int len, long now, int idx)
Scan the tunnel list from the given index for a reusable tunnel.
void
forceTunnelFailure(TunnelInfo cfg)
Force a tunnel to fail immediately and trigger a replacement build.
static String
formatPoolIdentity(TunnelPoolSettings settings)
Format a pool identity for log messages, combining nickname and truncated hash.
int
getActiveTunnelCount()
Count GOOD and TESTING (non-failed, not expired) tunnels in the pool.
(package private) long
getAdaptiveAvgTestDuration()
This pool's rolling average of completed test durations, used to adapt the test timeout multiplier.
(package private) long
getAdaptiveTestTimeout(long baseTimeout)
Adapt a base test timeout to this pool's observed test speed.
int
getAvgBWPerTunnel()
Average bandwidth per tunnel in the pool.
(package private) static int
getBuildTriesQuantityOverride(RouterContext ctx)
Quantity override threshold from config or default (12).
(package private) int
getConsecutiveBuildTimeouts()
Count of consecutive tunnel build timeouts.
(package private) int
getDifficultySpare()
Current difficulty spare for this pool.
(package private) int
getEffectiveTarget()
The tunnel count the pool builds and keeps: the ordinary active-count target, unaffected by any lease surge.
(package private) int
getHealthyTunnelCount()
Usable tunnels that are not soft-degraded: same filters as TunnelPool.getUsableTunnelCount() plus a floor on TunnelInfo.getSoftFailures().
LeaseSet
getInboundTunnelsAsLeaseSet()
Build and return current LeaseSet from our tunnels.
int
getInProgressCount()
Count tunnels currently being built.
(package private) static long
getLeaseMaxDuration(RouterContext ctx)
Maximum lease set lease duration from config or default (10 minutes).
(package private) static long
getLeaseSetBuildMinInterval(RouterContext ctx)
LeaseSet build minimum interval from config or default (2 minutes).
(package private) int
getLeaseSurgeNeed()
The advertiseable count an in-force surge needs, or 0 when none is.
static long
getLeaseViabilityWindow(RouterContext ctx)
A lease counts toward a re-mint while it has at least this much remaining: three minutes covers the re-sign request, floodfill propagation, and initial connection establishment, and a tunnel closer to expiry than this is already inside the pool's proactive replacement window (BuildExecutor starts replacing GOOD tunnels 330s out), so counting it would overstate the pool's health.
(package private) static int
getMaxConcurrentBuildsPerDirection(RouterContext ctx)
Max concurrent builds per direction from config or default (6).
int
getNearExpiryCount()
Tunnels in this pool whose lease falls inside the pre-build window.
(package private) TunnelPool
getPairedPool()
Paired pool (inbound <-> outbound for same destination).
(package private) long
getPruneEarlyExpiry()
Early expiry time for pruned tunnels.
(package private) static long
getPruneEarlyExpiry(RouterContext ctx)
Early expiry time for pruned tunnels, shared by every prune path (pool sweep and Remove Slow) so one pool's tunnels cannot be given a different head start than another's for the same configuration.
String
getRateName()
RateStat name for the bandwidth graph.
(package private) static long
getRefreshThrottle(RouterContext ctx)
Refresh throttle interval from config or default (2 minutes).
(package private) static int
getReplacementTunnelBuffer(double buildSuccess)
How many usable tunnels above the target the pool may hold before a further build must replace a non-GOOD tunnel instead of being added.
TunnelPoolSettings
getSettings()
Pool settings.
(package private) static long
getStartupTime(RouterContext ctx)
Startup suppression period from config or default (5 minutes).
int
getTestingTunnelCount()
Count tunnels that have been built but not yet passed their first test.
(package private) static int
getTunnelAvgLatency(TunnelInfo t)
Average test latency for a tunnel.
static int
getTunnelLifetime(RouterContext ctx)
Tunnel lifetime from config or default (11 minutes).
TunnelPoolManager
getTunnelPoolManager()
TunnelPoolManager that owns this pool.
(package private) int
getUsableTunnelCount()
Count tunnels that are usable for routing — not expired, not failed, not marked FAILING.
int
getValidTunnelCount()
Count valid (non-failed, not expired) tunnels in the pool.
(package private) static boolean
hasValidTunnelsBlockingEmergency(int validCount)
Emergency collapse is deferred while valid tunnels remain (soft-degraded or FAILING-but-not-FAILED).
(package private) boolean
hasZeroHopFallback()
Whether any active tunnel in this pool is a zero-hop fallback while the pool is configured for multi-hop.
(package private) void
incrementBuildTimeout()
Increment consecutive build timeout counter.
(package private) static boolean
isDeficitThrottled(long now, long lastBuild, int safeActive, int inProgress, boolean incompleteLeaseSet)
Compatibility overload: callers that only have a single usable count (no soft-degraded split) treat it as both healthy and safe.
(package private) static boolean
isDeficitThrottled(long now, long lastBuild, int healthySafe, int safeActive, int inProgress, boolean incompleteLeaseSet)
Whether a deficit-build batch must wait.
(package private) static boolean
isEmergencyCooldownActive(long elapsedMs, long usableCount, long inProgressCount)
Whether the emergency-cooldown window has elapsed.
(package private) static boolean
isEnsureThrottled(long now, long lastEnsure, int usableTunnelCount, boolean incompleteLeaseSet)
Whether ensureSufficientTunnels() must wait for this pool.
(package private) static boolean
isEnsureThrottled(long now, long lastEnsure, int usableTunnelCount, int healthyCount, boolean incompleteLeaseSet)
Whether ensureSufficientTunnels() must wait for this pool, using separate usable and healthy counts.
(package private) static boolean
isEnsureThrottled(long now, long lastEnsure, int usableTunnelCount, int healthyCount, boolean incompleteLeaseSet, long lastRemoval)
Whether ensureSufficientTunnels() must wait for this pool, using separate usable and healthy counts and a removal-time signal.
(package private) static boolean
isEnsureThrottled(long now, long lastEnsure, int usableTunnelCount, int healthyCount, boolean incompleteLeaseSet, long lastRemoval, int inProgress)
Whether ensureSufficientTunnels() must wait for this pool, using separate usable and healthy counts, a removal-time signal, and the number of builds in flight.
(package private) boolean
isExpiringSoon(long now)
Check if the LeaseSet is expiring soon (within 1 minute).
(package private) static boolean
isLastChanceTestable(long expiration, long now, long minLifeMs)
Whether a tunnel expiring within the pre-build window still has enough life left for a last-chance test to mean anything.
(package private) static boolean
isMateriallyShort(int leases, int wanted)
Whether a published LeaseSet is too small to count as a working set.
(package private) static boolean
isPreEmergencyBurstLive(long burstAt, long now, long window)
Whether this pool dispatched a pre-emergency burst recently enough that its in-flight builds are governed by the per-pool cap instead of the global budget.
(package private) boolean
isPreEmergencyExempt(long now)
Package-visible for the build executor: whether this pool's in-flight builds should bypass the global dispatch budget.
(package private) static boolean
isSoftDegraded(TunnelInfo t)
Whether the tunnel is soft-degraded for ensure/deficit purposes: still in the pool and not FAILING, but soft failures have reached TunnelPool.SOFT_DEGRADED_FOR_ENSURE.
(package private) static boolean
isSoftSendFailure(int status)
Whether the status is a soft best-effort send timeout (3).
boolean
isStruggling()
Whether this pool is struggling to meet its tunnel targets.
(package private) static boolean
isTrafficProvenUntestedLeaseCandidate(TunnelInfo tunnel, long expireAfter, long now)
Whether an inbound UNTESTED tunnel has verified delivering real data recently enough to be published as a lease.
(package private) static List<TunnelInfo>
leaseSurgeCandidates(List<TunnelInfo> tunnels, List<TunnelInfo> toRemove, long now)
Tunnels a lease surge may schedule for early expiry: GOOD, past the lease admission floor (so they can no longer be advertised), not already being pruned, and not recently active.
(package private) static long
maxExpirationStagger(long lifetimeMs)
Upper bound for the expiration stagger: keeps lifetime plus stagger under the NetDb's 15-minute future-lease rejection boundary with a 15-second margin, and never exceeds 4 minutes.
(package private) static String
noPeersSelectedLine(String destName, boolean inbound)
The entry naming the pool whose peer selection came up empty, so the reason a new tunnel could not be built is visible without a debug log.
(package private) void
notifyServerPoolTestFailed()
Called by TestJob when a server pool tunnel fails a test but is retained.
(package private) static int
partnerPreferenceTier(TunnelInfo info)
Rank a candidate test partner; lower is better.
(package private) static boolean
passesScanGates(TunnelInfo info, long now, boolean longTunnelsOnly)
Whether a pooled tunnel passes the scan eligibility gates: not failed, not over the consecutive-test-failure cap (test failures are often reply-path problems, not tunnel quality), non-expired, and — on the first pass.
(package private) void
proactiveRepublishIfHealthy()
Proactively republish the LeaseSet when all tunnels are healthy (all > 5 min expiry).
int
pruneExcessTunnels()
Prune excess tunnels from the pool to stay within budget.
(package private) void
removeInProgress(PooledTunnelCreatorConfig cfg)
Remove a config that was never actually sent to the network (e.g.
(package private) boolean
removeTunnelSynchronous(TunnelInfo info)
Synchronous tunnel removal for use during recovery or critical situations.
(package private) void
reportSendFailure(TunnelInfo cfg, int status)
Report a data-phase dispatch failure for a tunnel in this pool.
void
requestFreshTunnelBuild()
Request new inbound tunnels so the pool holds the target count with at least TunnelPool.getLeaseViabilityWindow(RouterContext) remaining.
void
requestLeaseSurge(int count)
Note how many advertiseable tunnels the imminent mint needs, so TunnelPool.pruneExcessTunnels() can offer up the ones that are no longer advertiseable until the pool has enough.
(package private) static long
rotateWindowStart(long windowStart, long now, long windowMs)
Roll the build-rate window forward when it has expired.
(package private) TunnelInfo
selectTunnelForTest()
Select a tunnel to serve as a test round's partner, preferring partners that have demonstrated they work.
(package private) void
setPairedPool(TunnelPool pool)
Paired pool (inbound <-> outbound for same destination).
(package private) void
setSettings(TunnelPoolSettings settings)
Update the settings for this pool.
(package private) static boolean
shouldBypassEnsureThrottle(boolean soft, int failures, boolean overBar)
Whether a data-phase failure signal is strong enough to run the ensure body immediately instead of through the throttle gate.
(package private) static boolean
shouldDeferMissingPublished(long lastRefreshTime, long now, long throttleMs)
Pure defer decision when NetDB has no local LeaseSet: true when a publish is still within the throttle window (async store pending), so forcing would only re-request the same data.
(package private) static boolean
shouldDeferPublishedRefresh(long earliestLeaseDate, long now, long throttleMs)
Pure earliest-keyed defer decision: the published LeaseSet still has full capacity (every remaining lease outlasts the throttle window), so this refresh may be deferred without losing reachability.
(package private) static boolean
shouldDropForLostSession(long firstMissingAt, long now, long hysteresis)
Whether a tunnel whose local session is gone should be dropped from the pool.
(package private) static boolean
shouldLogSendFailure(long now, long lastLogTime)
Whether a data-phase failure or condemnation line should be logged now.
(package private) static boolean
shouldSkipAsyncPublish(boolean hasPublishedLS, long lastRefreshTime, long now, long throttleMs)
Pure skip decision for publishLeaseSetIfNeeded: NetDB still null but we published within the throttle window — treat as in-flight rather than missing, so tunnel-add does not re-request every build.
(package private) static boolean
shouldWarnSelectPeersFailure(long uptime, long now, long lastWarnTime)
The selectPeers-failure WARN is rate-limited: never before TunnelPool.SELECT_PEERS_FAILURE_SILENCE_MS of uptime, then at most once per TunnelPool.SELECT_PEERS_FAILURE_WARN_INTERVAL_MS per pool.
static int
softRemovalThreshold()
The soft failure count that marks a tunnel for retention.
(package private) static long
stampLostSession(long currentMissingAt, long now)
The value to record for a tunnel whose local transport session has just been observed missing.
(package private) static double
timeoutRate(long attempts, long timeouts)
Fraction of counted build attempts that timed out.
(package private) void
tunnelFailedWithoutBlame(TunnelInfo cfg)
Mark a tunnel failed without blaming any peer.
(package private) void
updateAdaptiveTestDuration(long durationMs)
Record a completed test duration and adapt this pool's test window.
(package private) static double
updatedAdaptiveTestMultiplier(double mult, long avgMs)
Next test timeout multiplier for a given rolling average.
(package private) static long
updatedAvgTestDuration(long avg, long sample)
Fold a completed test duration into the rolling average.
(package private) static int
usableLeaseMinimum(int wanted)
The smallest LeaseSet treated as usable for a given target.
(package private) static String
zombieTransportBucket(String style)
Normalise a RouterInfo transport style into one of the known transports.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _aliasOf
  private final TunnelPool _aliasOf
  The pool this one is a handle on.
Constructor Details
- AliasedTunnelPool
  AliasedTunnelPool(RouterContext ctx, TunnelPoolManager mgr, TunnelPoolSettings settings, TunnelPool aliasOf)
  Create an aliased tunnel pool.
  Parameters:
  ctx - the router context
  mgr - the tunnel pool manager
  settings - the pool settings
  aliasOf - the pool to use for tunnel selection
Method Details
- startup
  void startup()
  Description copied from class: TunnelPool
  Warning, this may be called more than once (without an intervening shutdown()) if the tunnel is stopped and then restarted by the client manager with the same Destination (i.e. for servers or clients w/ persistent key, or restarting close-on-idle clients).
  Overrides:
  startup in class TunnelPool
- shutdown
  void shutdown()
  Description copied from class: TunnelPool
  Shut down the pool and clean up resources.
  Overrides:
  shutdown in class TunnelPool
- selectTunnel
  TunnelInfo selectTunnel()
  Description copied from class: TunnelPool
  Pull a random tunnel out of the pool. If there are none available but the pool is configured to allow 0hop tunnels, this builds a fake one and returns it.
  Overrides:
  selectTunnel in class TunnelPool
  Returns:
  null on failure, but it should always build and return a fallback
- selectTunnel
  TunnelInfo selectTunnel(Hash closestTo)
  Description copied from class: TunnelPool
  Return the tunnel from the pool that is XOR-closest to the target. By using this instead of the random TunnelPool.selectTunnel(), we force some locality in OBEP-IBGW connections to minimize those connections network-wide.
  Does not check for backlogged next peer. Does not return an expired tunnel.
  Overrides:
  selectTunnel in class TunnelPool
  Parameters:
  closestTo - the hash to find the closest tunnel to
  Returns:
  the tunnel closest to the target, or null on failure
- getTunnel
  public TunnelInfo getTunnel(TunnelId gatewayId)
  Description copied from class: TunnelPool
  Tunnel by its gateway tunnel ID.
  Overrides:
  getTunnel in class TunnelPool
  Parameters:
  gatewayId - for inbound, the GW rcv tunnel ID; for outbound, the GW send tunnel ID.
  Returns:
  the tunnel with the matching gateway ID, or null if not found
- listTunnels
  public List<TunnelInfo> listTunnels()
  Description copied from class: TunnelPool
  List of tunnels currently in the pool.
  Overrides:
  listTunnels in class TunnelPool
  Returns:
  a copy of the list of TunnelInfo objects
- needFallback
  boolean needFallback()
  Description copied from class: TunnelPool
  Do we really need more fallbacks? Used to prevent a zillion of them. Does not check config, only call if config allows zero hop.
  Overrides:
  needFallback in class TunnelPool
  Returns:
  true if more fallback tunnels are needed
- listPending
  public List<PooledTunnelCreatorConfig> listPending()
  Description copied from class: TunnelPool
  List of tunnelInfo instances of tunnels currently being built.
  Overrides:
  listPending in class TunnelPool
  Returns:
  the list of tunnels currently being built
- isAlive
  public boolean isAlive()
  Description copied from class: TunnelPool
  Is this pool running AND either exploratory, or tracked by the client manager? A pool will be alive but not tracked after the client manager removes it but before all the tunnels have expired.
  Overrides:
  isAlive in class TunnelPool
  Returns:
  true if the pool is alive and should be tracked
- size
  public int size()
  Description copied from class: TunnelPool
  Count every tunnel in the pool, including failed and expired ones awaiting cleanup.
  Overrides:
  size in class TunnelPool
  Returns:
  the number of tunnels in the pool
- addTunnel
  protected void addTunnel(TunnelInfo info)
  Description copied from class: TunnelPool
  Add a tunnel to the pool.
  Overrides:
  addTunnel in class TunnelPool
  Parameters:
  info - the tunnel to add
- removeTunnel
  void removeTunnel(TunnelInfo info)
  Description copied from class: TunnelPool
  Remove a tunnel from the pool.
  Overrides:
  removeTunnel in class TunnelPool
  Parameters:
  info - the tunnel to remove
- tunnelFailed
  void tunnelFailed(TunnelInfo cfg)
  Description copied from class: TunnelPool
  Remove tunnel and blame all peers (not necessarily equally). This may be called multiple times from TestJob. Enhanced with intelligent failure analysis and recovery.
  Overrides:
  tunnelFailed in class TunnelPool
  Parameters:
  cfg - the tunnel that failed
- tunnelFailed
  void tunnelFailed(TunnelInfo cfg, Hash blamePeer)
  Description copied from class: TunnelPool
  Remove the tunnel and blame only one peer. This may be called multiple times. Data-phase first-hop send failures also feed the selection cooldown and the tier-demotion strike tracker so a persistently failing first hop is not re-selected on the next tunnel generation.
  Overrides:
  tunnelFailed in class TunnelPool
  Parameters:
  cfg - the tunnel that failed
  blamePeer - the peer to blame
- refreshLeaseSet
  void refreshLeaseSet()
  Description copied from class: TunnelPool
  No-op for outbound and exploratory pools.
  Overrides:
  refreshLeaseSet in class TunnelPool
- refreshLeaseSet
  public void refreshLeaseSet(boolean force)
  Description copied from class: TunnelPool
  Refresh the LeaseSet, throttled to prevent flooding but not on initial creation. Public so the netdb facade can nudge local-dest refresh on accessLeaseSet.
  Overrides:
  refreshLeaseSet in class TunnelPool
  Parameters:
  force - if true, bypass throttle (for critical refresh when below minimum or near expiry)
- buildFallback
  boolean buildFallback()
  Description copied from class: TunnelPool
  This will build a fallback (zero-hop) tunnel ONLY if this pool is exploratory, or the settings allow it. Matches upstream: client pools with zero-hop disabled must never fall back to 0-hop, since such a tunnel would be selected for data and would fail every connection through it.
  Overrides:
  buildFallback in class TunnelPool
  Returns:
  true if a fallback tunnel is built, false otherwise
- locked_buildNewLeaseSet
  protected LeaseSet locked_buildNewLeaseSet()
  Description copied from class: TunnelPool
  Build a leaseSet with the required tunnels that aren't about to expire. Caller must hold _tunnelsLock. The returned LeaseSet will be incomplete; it will not have the destination set and will not be signed. Only the leases will be included.
  Overrides:
  locked_buildNewLeaseSet in class TunnelPool
  Returns:
  null on failure
- getLifetimeProcessed
  public long getLifetimeProcessed()
  Description copied from class: TunnelPool
  Total lifetime processed bytes for this pool.
  Overrides:
  getLifetimeProcessed in class TunnelPool
  Returns:
  the total number of bytes processed through this pool
- configureNewTunnel
  PooledTunnelCreatorConfig configureNewTunnel()
  Description copied from class: TunnelPool
  This only sets the peers and creation/expiration times in the configuration. For the crypto, see BuildRequestor and BuildMessageGenerator.
  Overrides:
  configureNewTunnel in class TunnelPool
  Returns:
  null on failure
- ensureSufficientTunnels
  void ensureSufficientTunnels()
  Aliased pools have no tunnels of their own; the primary pool builds and maintains tunnels for all aliases. Running the full build-decision logic on the empty local pool would log false "EMERGENCY: Zero usable tunnels" warnings and waste cycles on every maintenance pass.
  Overrides:
  ensureSufficientTunnels in class TunnelPool
- buildComplete
  void buildComplete(PooledTunnelCreatorConfig cfg, BuildExecutor.Result result)
  Description copied from class: TunnelPool
  Remove from the _inprogress list and call addTunnel() if result is SUCCESS. Updates consecutive build timeout count.
  Overrides:
  buildComplete in class TunnelPool
  Parameters:
  cfg - the completed tunnel configuration
  result - the build result
- toString
  public String toString()
  Description copied from class: TunnelPool
  Description of the pool and its settings.
  Overrides:
  toString in class TunnelPool

Nested Class Summary

Nested classes/interfaces inherited from class TunnelPool

Field Summary

Fields inherited from class TunnelPool

Constructor Summary

Method Summary

Methods inherited from class TunnelPool

Methods inherited from class Object

Field Details

_aliasOf

Constructor Details

Method Details

startup

shutdown

selectTunnel

selectTunnel

getTunnel

listTunnels

needFallback

listPending

isAlive

size

addTunnel

removeTunnel

tunnelFailed

tunnelFailed

refreshLeaseSet

refreshLeaseSet

buildFallback

locked_buildNewLeaseSet

getLifetimeProcessed

configureNewTunnel

ensureSufficientTunnels

buildComplete

toString