I2PTunnelClient

net.i2p.i2ptunnel.I2PTunnelClient

All Implemented Interfaces:: Runnable, EventDispatcher

public class I2PTunnelClientextends I2PTunnelClientBase

Standard I2P client tunnel that forwards local TCP connections to I2P destinations.

Listens on a local port and creates I2P connections to configured destinations when clients connect. Supports multiple destinations with random selection, configurable read timeouts, and port mapping for services like SMTP and POP.

Handles destination resolution, connection management, and data forwarding between local client socket and remote I2P destination.

Field Summary
Fields
Modifier and Type
Field
Description
protected long
readTimeout
Idle timeout in milliseconds for I2P socket reads on new connections.
Fields inherited from class I2PTunnelClientBase
_clientId, _context, _executor, _log, _ownDest, DEFAULT_CONNECT_TIMEOUT, DEFAULT_MAX_CONNECTIONS, DEFAULT_SOCKET_OPEN_TIMEOUT, dest, l, listenerReady, MAX_TIMEOUT_FAILOVER, MIN_CONNECT_LEG_MS, mySockets, NO_DEADLINE, POOL_BUILD_DEADLINE_GRACE_MS, PROP_MAX_CONNECTIONS, PROP_USE_SSL, REQUEST_CONNECT_DEADLINE_MS, sockLock, sockMgr, ss
Modifier and Type
Field
Description
protected long
_clientId
This client's ID.
protected final I2PAppContext
_context
The application context.
protected ThreadPoolExecutor
_executor
Thread pool executor.
protected final Log
_log
The logger.
protected boolean
_ownDest
Whether we own our destination.
(package private) static final long
DEFAULT_CONNECT_TIMEOUT
Default connect timeout.
static final int
DEFAULT_MAX_CONNECTIONS
Default cap on concurrently handled client connections.
static final long
DEFAULT_SOCKET_OPEN_TIMEOUT
Default socket open timeout in ms, after which close() will proceed even with active sockets.
protected Destination
dest
The destination.
protected final Logging
l
The logging instance.
protected boolean
listenerReady
Protected for I2Ping since 0.9.11.
(package private) static final int
MAX_TIMEOUT_FAILOVER
Legacy cap on consecutive connect timeouts before abandoning tunnel failover.
(package private) static final long
MIN_CONNECT_LEG_MS
Minimum remaining budget for starting one connect leg.
protected final List<I2PSocket>
mySockets
List of active sockets.
(package private) static final long
NO_DEADLINE
Deadline sentinel for callers that have not adopted the shared request budget (SOCKS, IRC, DCC, raw createI2PSocket): they keep their original per-call limits because this sentinel never reads as expired and never clamps.
(package private) static final long
POOL_BUILD_DEADLINE_GRACE_MS
One-shot deadline extension granted while the outbound tunnel pool is still building (poolState() == 0) when the shared budget runs out.
static final String
PROP_MAX_CONNECTIONS
Property name: max concurrently active client connections handled by one client tunnel.
static final String
PROP_USE_SSL
Property for SSL enable.
(package private) static final long
REQUEST_CONNECT_DEADLINE_MS
Single wall-clock budget for establishing one proxied request.
protected final Object
sockLock
Guards sockMgr and mySockets.
protected I2PSocketManager
sockMgr
The socket manager.
protected ServerSocket
ss
Server socket.
Fields inherited from class I2PTunnelTask
open, tunnel
Modifier and Type
Field
Description
protected boolean
open
True while the tunnel is running and accepting connections.
I2PTunnel
tunnel
The I2PTunnel this task runs inside.
Constructor Summary
Constructors
Constructor
Description
I2PTunnelClient(int localPort, String destinations, Logging l, boolean ownDest, EventDispatcher notifyThis, I2PTunnel tunnel, String pkf)
Create a standard client tunnel listening on localPort, forwarding to the given destinations.
Method Summary
All Methods
Modifier and Type
Method
Description
protected void
clientConnectionRun(Socket s)
Handles an incoming local socket by selecting a remote destination and forwarding data.
boolean
close(boolean forced)
Overridden to unregister with port mapper.
long
getReadTimeout()
Get the read idle timeout for newly-created connections (in milliseconds).
void
optionsUpdated(I2PTunnel tunnel)
Update the dests then call super.
void
setReadTimeout(long ms)
Set the read idle timeout for newly-created connections (in milliseconds).
void
startRunning()
Actually start working on incoming connections.
Methods inherited from class I2PTunnelClientBase
buildSocketManager, buildSocketManager, buildSocketManager, buildSocketManager, clampToDeadlineMs, closeSocket, connectDeadlineFrom, createI2PSocket, createI2PSocket, createI2PSocket, createI2PSocket, destroy, extendDeadlineForBuildingPool, getDefaultOptions, getDefaultOptions, getEffectiveMaxConnections, getListenHost, getLocalPort, getSocketManager, getSocketManager, getSocketOpenTimeout, isConnectTimeout, isDeadlineExpired, legConnectTimeoutMs, manageConnection, poolIsDefinitivelyDown, poolState, resolveEffectiveMaxConnections, resolveMaxConnections, resolveRunnerCeiling, run, shouldContinueFailover, shouldContinueFailover, shouldOuterRetryConnect, shouldOuterRetryConnect, verifySocketManager, writeShedResponse
Modifier and Type
Method
Description
protected I2PSocketManager
buildSocketManager()
For NON-SHARED clients (ownDest = true).
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel)
Create a disconnected socket manager for the tunnel, with no private key file.
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel, String pkf)
Create a disconnected socket manager for the tunnel, loading the persistent client dest from pkf if it is non-null.
protected static I2PSocketManager
buildSocketManager(I2PTunnel tunnel, String pkf, Logging log)
Create a disconnected socket manager for the tunnel, loading the persistent client dest from pkf if it is non-null, and logging any key file error to log.
(package private) static long
clampToDeadlineMs(long requestedMs, long deadlineMs, long nowMs)
Clamp a requested timeout to the time left before a shared deadline.
static void
closeSocket(Socket s)
Close a socket silently.
(package private) static long
connectDeadlineFrom(long nowMs)
Compute the shared connect deadline for a request starting now.
I2PSocket
createI2PSocket(Destination dest)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
I2PSocket
createI2PSocket(Destination dest, int port)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
I2PSocket
createI2PSocket(Destination dest, I2PSocketOptions opt)
Create a new I2PSocket towards to the specified destination, adding it to the list of connections actually managed by this tunnel.
(package private) I2PSocket
createI2PSocket(Destination dest, I2PSocketOptions opt, long deadlineMs)
Create a new I2PSocket bounded by a shared request deadline.
boolean
destroy()
Note that the tunnel cannot be reopened after this by calling startRunning(), as it will destroy the underlying socket manager.
(package private) static long
extendDeadlineForBuildingPool(long deadlineMs, long nowMs, int poolState, boolean alreadyExtended)
One-shot deadline extension for a request whose outbound tunnel pool is still building when the shared deadline runs out.
protected I2PSocketOptions
getDefaultOptions()
Create the default options (using the default timeout, etc).
protected I2PSocketOptions
getDefaultOptions(Properties overrides)
Create the default options (using the default timeout, etc).
(package private) int
getEffectiveMaxConnections()
The effective concurrent-connection cap for this tunnel at the moment the accept loop admits a connection.
protected final InetAddress
getListenHost(Logging l)
Get the listen host address.
final int
getLocalPort()
Get the local port.
I2PSocketManager
getSocketManager()
Returns the I2PSocketManager for this task.
protected static I2PSocketManager
getSocketManager(I2PTunnel tunnel, String pkf)
This is ONLY for shared clients.
long
getSocketOpenTimeout()
Returns the socket open timeout in ms; close() will proceed after this even with active sockets.
(package private) static boolean
isConnectTimeout(Throwable e)
For timeout wording.
(package private) static boolean
isDeadlineExpired(long deadlineMs, long nowMs)
Whether a shared connect deadline has passed.
(package private) static long
legConnectTimeoutMs(long requestedMs, long deadlineMs, long nowMs)
Compute the connect timeout to apply to one failover leg under a shared deadline.
protected void
manageConnection(Socket s)
Manage the connection just opened on the specified socket.
protected boolean
poolIsDefinitivelyDown()
And none are being built, so further connect retries cannot succeed.
protected int
poolState()
Router-context only, best-effort check of the client outbound tunnel pool.
(package private) static int
resolveEffectiveMaxConnections(boolean customized, int ownCap, int globalDefault)
Pure decision helper for I2PTunnelClientBase.getEffectiveMaxConnections(): pick the per-tunnel override when one was explicitly configured, otherwise the Tuner-managed default cap.
(package private) static int
resolveMaxConnections(String configured)
Resolve the max-concurrent-connections cap from the tunnel's configured value.
(package private) static int
resolveRunnerCeiling(boolean customized, int effectiveMax)
Ceiling to pin on this tunnel's runner pool at creation time.
void
run()
Non-final since 0.9.11.
(package private) static boolean
shouldContinueFailover(int tunnelCount, int attemptsMade, int timeoutFailures, boolean poolDown)
Whether another tunnel-failover attempt is worthwhile after a connect failure.
(package private) static boolean
shouldContinueFailover(int tunnelCount, int attemptsMade, int timeoutFailures, boolean poolDown, boolean poolBuilding)
Whether another tunnel-failover attempt is worthwhile after a connect failure.
(package private) static boolean
shouldOuterRetryConnect(int connectAttempts, int timeoutConnectAttempts, boolean timedOut, boolean poolDown, boolean poolBuilding, boolean browserClosed)
Whether the outer HTTP connect loop should retry after a failure.
(package private) static boolean
shouldOuterRetryConnect(int connectAttempts, int timeoutConnectAttempts, boolean timedOut, int poolState, boolean deadlineExpired)
Whether the outer HTTP connect loop should retry after a failure, given the single pool-state snapshot taken for that failure.
protected void
verifySocketManager()
Create the manager if it doesn't exist, AND connect it to the router and build tunnels.
protected void
writeShedResponse(Socket s)
Best-effort shed response on the browser-facing socket, then close it.
Methods inherited from class I2PTunnelTask
connected, disconnected, errorOccurred, getBooleanOption, getId, getTunnel, isOpen, reportAbuse, routerDisconnected, setId, setName, setTunnel, toString
Modifier and Type
Method
Description
void
connected(I2PSession session)
For tasks that don't call I2PTunnel.addSession(I2PSession) directly.
void
disconnected(I2PSession session)
Called when a session is disconnected.
void
errorOccurred(I2PSession session, String message, Throwable error)
Does nothing here.
protected boolean
getBooleanOption(String opt, boolean dflt)
Read a boolean client option from the tunnel's properties.
int
getId()
The id of the client list entry for this task.
I2PTunnel
getTunnel()
The I2PTunnel this task runs inside.
boolean
isOpen()
Whether the tunnel is running and accepting connections.
void
reportAbuse(I2PSession session, int severity)
Does nothing here.
protected void
routerDisconnected()
Tell the tunnel that the router connection has dropped.
void
setId(int id)
Record the client list entry id for this task.
protected void
setName(String name)
Record the display name for this task.
void
setTunnel(I2PTunnel pTunnel)
Rebind this task to a different tunnel.
String
toString()
The display name given to this task when it was constructed.
Methods inherited from class EventDispatcherImpl
attachEventDispatcher, detachEventDispatcher, getEventDispatcher, getEvents, getEventValue, ignoreEvents, notifyEvent, unIgnoreEvents, waitEventValue
Modifier and Type
Method
Description
void
attachEventDispatcher(EventDispatcher ev)
Attach an EventDispatcher object to the events dispatching chain.
void
detachEventDispatcher(EventDispatcher ev)
Detach the specified EventDispatcher object from the events dispatching chain.
EventDispatcher
getEventDispatcher()
Object to be used to deliver events (usually this, but YMMV).
Set<String>
getEvents()
Retrieve the names of all the events that have been received.
Object
getEventValue(String name)
Retrieve the value currently associated with the specified event value.
void
ignoreEvents()
Ignore further event notifications.
void
notifyEvent(String eventName, Object args)
Deliver an event.
void
unIgnoreEvents()
Almost like the method above :-).
Object
waitEventValue(String name)
Wait until the given event has received a value.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- readTimeout
  protected long readTimeout
  Idle timeout in milliseconds for I2P socket reads on new connections. ≤ 0 means no timeout.
Constructor Details
- I2PTunnelClient
  public I2PTunnelClient(int localPort, String destinations, Logging l, boolean ownDest, EventDispatcher notifyThis, I2PTunnel tunnel, String pkf) throws IllegalArgumentException
  Create a standard client tunnel listening on localPort, forwarding to the given destinations. As of 0.9.20 this is fast, and does NOT connect the manager to the router, or open the local socket. You MUST call startRunning() for that.
  Parameters:
  localPort - if 0, use any port, get actual port selected with getLocalPort()
  destinations - peers we target, comma- or space-separated. Since 0.9.9, each dest may be appended with :port
  l - the logging instance
  ownDest - whether to use an owned destination
  notifyThis - the event dispatcher for notifications
  tunnel - the I2PTunnel instance, supplying the context and listen host
  pkf - the path to a persistent private key file, or null to generate one
  Throws:
  IllegalArgumentException - if the I2PTunnel does not contain valid config to contact the router
Method Details
- setReadTimeout
  public void setReadTimeout(long ms)
  Set the read idle timeout for newly-created connections (in milliseconds). After this time expires without data being reached from the I2P network, the connection itself will be closed.
  Less than or equal to 0 means forever. Default -1 (forever) as of 0.9.36 for standard tunnels, but extending classes may override. Prior to that, default was 5 minutes, but did not work due to streaming bugs.
  Applies only to future connections; calling this does not affect existing connections.
  Parameters:
  ms - the idle timeout in ms; zero or negative means forever
- getReadTimeout
  public long getReadTimeout()
  Get the read idle timeout for newly-created connections (in milliseconds).
  Less than or equal to 0 means forever. Default -1 (forever) as of 0.9.36 for standard tunnels, but extending classes may override. Prior to that, default was 5 minutes, but did not work due to streaming bugs.
  Returns:
  the idle timeout in ms; zero or negative means forever
- clientConnectionRun
  protected void clientConnectionRun(Socket s)
  Handles an incoming local socket by selecting a remote destination and forwarding data.
  Specified by:
  clientConnectionRun in class I2PTunnelClientBase
  Parameters:
  s - the socket to manage
- optionsUpdated
  public void optionsUpdated(I2PTunnel tunnel)
  Update the dests then call super.
  Overrides:
  optionsUpdated in class I2PTunnelClientBase
  Parameters:
  tunnel - the tunnel whose client options were updated
- startRunning
  public void startRunning()
  Actually start working on incoming connections. Overridden to register with port mapper.
  Overrides:
  startRunning in class I2PTunnelClientBase
- close
  public boolean close(boolean forced)
  Overridden to unregister with port mapper.
  Overrides:
  close in class I2PTunnelClientBase
  Parameters:
  forced - true to interrupt an in-progress build, false to close gracefully
  Returns:
  true if the tunnel is closed, or false if connections were still active and the close was refused

Field Summary

Fields inherited from class I2PTunnelClientBase

Fields inherited from class I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class I2PTunnelClientBase

Methods inherited from class I2PTunnelTask

Methods inherited from class EventDispatcherImpl

Methods inherited from class Object

Field Details

readTimeout

Constructor Details

Method Details

setReadTimeout

getReadTimeout

clientConnectionRun

optionsUpdated

startRunning

close