I2PTunnelDCCServer

net.i2p.i2ptunnel.irc.I2PTunnelDCCServer

All Implemented Interfaces:: Runnable, EventDispatcher

public class I2PTunnelDCCServerextends I2PTunnelServer

A standard server that only answers for registered ports, and each port can only be used once.


                                           direct conn
               <---> I2PTunnelDCCServer <--------------->I2PTunnelDCCClient <---->
  originating                                                                     responding
  chat client                                                                     chat client
       CHAT    ---> I2PTunnelIRCClient --> IRC server --> I2TunnelIRCClient ----->
       SEND    ---> I2PTunnelIRCClient --> IRC server --> I2TunnelIRCClient ----->
       RESUME  <--- I2PTunnelIRCClient <-- IRC server <-- I2TunnelIRCClient <-----
       ACCEPT  ---> I2PTunnelIRCClient --> IRC server --> I2TunnelIRCClient ----->

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static class
I2PTunnelDCCServer.LocalAddress
One local address handed out for a DCC connection.
Field Summary
Fields
Modifier and Type
Field
Description
private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress>
_active
Key is the server's local I2P port.
private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress>
_outgoing
Key is the server's local I2P port.
private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress>
_resume
Key is the server's local I2P port.
private final List<I2PSocket>
_sockList
The open DCC sockets.
private static final long
DEFAULT_DCC_READ_TIMEOUT
Default idle time before a DCC socket is dropped.
private static final InetAddress
DUMMY
Just to keep super() happy.
private static final int
MAX_I2P_PORT
Largest DCC port accepted.
private static final int
MAX_OUTGOING_ACTIVE
Outgoing DCC connections allowed open.
private static final int
MAX_OUTGOING_PENDING
Outgoing DCC connections allowed pending.
private static final int
MIN_I2P_PORT
Smallest DCC port accepted.
private static final long
OUTBOUND_EXPIRE
Time before an unused local address expires.
Fields inherited from class I2PTunnelServer
_clientExecutor, _log, _tcg, bidir, i2pss, l, localPort, PROP_ALT_PKF, PROP_MAX_CONNECTIONS, PROP_READ_TIMEOUT, PROP_SERVER_THREADS, PROP_UNIQUE_LOCAL, PROP_USE_SSL, PROP_WRITE_TIMEOUT, readTimeout, remoteHost, remotePort, serverId, slock, sockMgr, sslLock, task
Modifier and Type
Field
Description
protected ThreadPoolExecutor
_clientExecutor
Pool running the per-connection client handlers, taken from the TunnelControllerGroup so server load stays inside its own thread budget.
protected final Log
_log
Logger for this tunnel server.
protected TunnelControllerGroup
_tcg
The controller group that owns this tunnel's runner pool, cached from TunnelControllerGroup.getInstance() once in I2PTunnelServer.run().
protected boolean
bidir
True for HTTP bidirectional server mode.
protected I2PServerSocket
i2pss
The listening server socket, null until the tunnel is started.
protected final Logging
l
Client-visible log channel: every lifecycle notice and warning reported to the I2P client (bad option values, unresolvable hosts, lingering connections).
protected int
localPort
Local port a HTTP bidir subclass hands to its proxy, replacing the I2PTunnelServer.DEFAULT_LOCAL_PORT placeholder.
static final String
PROP_ALT_PKF
Config key naming an alternate private key file.
static final String
PROP_MAX_CONNECTIONS
Config key to cap concurrent inbound connections; 0 (default) = unlimited.
static final String
PROP_READ_TIMEOUT
Config key to override the socket read timeout in ms; 0 (default) = shut down silent connections promptly (HTTP server falls back to SERVER_READ_TIMEOUT_GET).
static final String
PROP_SERVER_THREADS
Config key to cap this tunnel's private server handler pool in threads.
static final String
PROP_UNIQUE_LOCAL
Config key to enable unique local address.
static final String
PROP_USE_SSL
Config key to enable SSL.
static final String
PROP_WRITE_TIMEOUT
Config key to override the outbound write timeout in ms (0 = use the streaming default, which can be the full 120s disconnect timeout with no ACK progress).
protected long
readTimeout
Default timeout - override if desired.
protected InetAddress
remoteHost
Remote endpoint of the current connection, null for the listening server.
protected int
remotePort
Remote port of the current connection, 0 for the listening server.
protected static long
serverId
Server ID for HTTP bidirectional proxies; not incremented, always 0.
protected final Object
slock
Passed to each I2PTunnelRunner so connection teardown serializes on it.
protected final I2PSocketManager
sockMgr
Builds the outbound sockets used to reach each configured destination.
protected final Object
sslLock
Guards lazy creation of _sslFactory.
protected I2PTunnelTask
task
HTTP bidirectional server task, null for standard tunnel server.
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
I2PTunnelDCCServer(I2PSocketManager sktMgr, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)
There's no support for unsolicited incoming I2P connections, so there's no server host or port parameters.
Method Summary
Modifier and Type
Method
Description
int
acceptOutgoing(int port)
An outgoing ACCEPT response.
protected void
blockingHandle(I2PSocket socket)
An incoming DCC connection, only accept for a known port.
boolean
close(boolean forced)
Closes all connections and clears all pending/outgoing/active maps.
private void
expireOutbound()
Drops the expired outgoing DCC connections.
private int
newOutgoing(byte[] ip, int port, int i2pPort)
Register an outgoing DCC session, returning its id.
int
newOutgoing(byte[] ip, int port, String type)
An outgoing DCC request.
int
resumeIncoming(int port)
An incoming RESUME request.
Methods inherited from class I2PTunnelServer
destroy, getReadTimeout, getSocket, getSocket, getSocketManager, getSocketString, optionsUpdated, rejectConnection, rejectConnection, releaseConnection, run, setReadTimeout, startRunning, tryAcquireConnection
Modifier and Type
Method
Description
boolean
destroy()
Note that the tunnel cannot be reopened after this by calling startRunning(), as it will destroy the underlying socket manager.
long
getReadTimeout()
Get the read idle timeout for newly-created connections (in milliseconds).
protected Socket
getSocket(Hash from, int incomingPort)
Creates a TCP socket connection to the configured destination.
protected Socket
getSocket(Hash from, InetAddress remoteHost, int remotePort)
Creates a TCP socket connection to the specified destination.
I2PSocketManager
getSocketManager()
Return the socket manager, or null if destroyed.
protected String
getSocketString(int incomingPort)
Gets a human-readable string representation of the target socket.
void
optionsUpdated(I2PTunnel tunnel)
Update the I2PSocketManager.
protected void
rejectConnection(I2PSocket socket)
Refuse an inbound connection when the gate cap is exceeded.
protected void
rejectConnection(I2PSocket socket, boolean queueFull)
Refuse an inbound connection with an accurate reason.
protected void
releaseConnection()
Release a reservation taken by I2PTunnelServer.tryAcquireConnection().
void
run()
Runs the I2PTunnelServer to accept and handle incoming connections asynchronously.
void
setReadTimeout(long ms)
Set the read idle timeout for newly-created connections (in milliseconds).
void
startRunning()
Start running the I2PTunnelServer.
protected boolean
tryAcquireConnection()
Try to reserve a slot in the concurrent-connection gate.
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
- _outgoing
  private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress> _outgoing
  Key is the server's local I2P port.
- _active
  private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress> _active
  Key is the server's local I2P port.
- _resume
  private final ConcurrentHashMap<Integer, I2PTunnelDCCServer.LocalAddress> _resume
  Key is the server's local I2P port.
- _sockList
  private final List<I2PSocket> _sockList
  The open DCC sockets.
- DUMMY
  private static final InetAddress DUMMY
  Just to keep super() happy.
- MIN_I2P_PORT
  private static final int MIN_I2P_PORT
  Smallest DCC port accepted.
  See Also:
  Constant Field Values
- MAX_I2P_PORT
  private static final int MAX_I2P_PORT
  Largest DCC port accepted.
  See Also:
  Constant Field Values
- MAX_OUTGOING_PENDING
  private static final int MAX_OUTGOING_PENDING
  Outgoing DCC connections allowed pending.
  See Also:
  Constant Field Values
- MAX_OUTGOING_ACTIVE
  private static final int MAX_OUTGOING_ACTIVE
  Outgoing DCC connections allowed open.
  See Also:
  Constant Field Values
- OUTBOUND_EXPIRE
  private static final long OUTBOUND_EXPIRE
  Time before an unused local address expires.
  See Also:
  Constant Field Values
- DEFAULT_DCC_READ_TIMEOUT
  private static final long DEFAULT_DCC_READ_TIMEOUT
  Default idle time before a DCC socket is dropped.
  See Also:
  Constant Field Values
Constructor Details
- I2PTunnelDCCServer
  public I2PTunnelDCCServer(I2PSocketManager sktMgr, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)
  There's no support for unsolicited incoming I2P connections, so there's no server host or port parameters.
  Parameters:
  sktMgr - an existing socket manager
  l - the logging system the base class reports through
  notifyThis - the dispatcher notified of connection and transfer events
  tunnel - the owning I2PTunnel supplying the router context and configuration
  Throws:
  IllegalArgumentException - if the I2PTunnel does not contain valid config to contact the router
Method Details
- blockingHandle
  protected void blockingHandle(I2PSocket socket)
  An incoming DCC connection, only accept for a known port. Passed through without filtering.
  Overrides:
  blockingHandle in class I2PTunnelServer
  Parameters:
  socket - the incoming I2P socket connection
  See Also:
  I2PTunnelServer.getSocket(Hash, int)
  I2PTunnelRunner
- close
  public boolean close(boolean forced)
  Closes all connections and clears all pending/outgoing/active maps.
  Overrides:
  close in class I2PTunnelServer
  Parameters:
  forced - unused, for interface compatibility
  Returns:
  true if closed successfully
- newOutgoing
  public int newOutgoing(byte[] ip, int port, String type)
  An outgoing DCC request.
  Parameters:
  ip - local irc client IP
  port - local irc client port
  type - ignored; the overload always lets the router pick the I2P port
  Returns:
  i2p port or -1 on error
- newOutgoing
  private int newOutgoing(byte[] ip, int port, int i2pPort)
  Register an outgoing DCC session, returning its id.
  Parameters:
  ip - local irc client IP
  port - local dcc server I2P port or 0 to pick one at random
  i2pPort - the I2P port to reserve, or 0 to pick an unused one at random
  Returns:
  the reserved I2P port, or -1 on error
- resumeIncoming
  public int resumeIncoming(int port)
  An incoming RESUME request.
  Parameters:
  port - local dcc server I2P port
  Returns:
  local IRC client DCC port or -1 on error
- acceptOutgoing
  public int acceptOutgoing(int port)
  An outgoing ACCEPT response.
  Parameters:
  port - local irc client DCC port
  Returns:
  local DCC server i2p port or -1 on error
- expireOutbound
  private void expireOutbound()
  Drops the expired outgoing DCC connections.

Nested Class Summary

Field Summary

Fields inherited from class I2PTunnelServer

Fields inherited from class I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class I2PTunnelServer

Methods inherited from class I2PTunnelTask

Methods inherited from class EventDispatcherImpl

Methods inherited from class Object

Field Details

_outgoing

_active

_resume

_sockList

DUMMY

MIN_I2P_PORT

MAX_I2P_PORT

MAX_OUTGOING_PENDING

MAX_OUTGOING_ACTIVE

OUTBOUND_EXPIRE

DEFAULT_DCC_READ_TIMEOUT

Constructor Details

Method Details

blockingHandle

close

newOutgoing

newOutgoing

resumeIncoming

acceptOutgoing

expireOutbound