SOCKSUDPTunnel

net.i2p.i2ptunnel.socks.SOCKSUDPTunnel

All Implemented Interfaces:: Sink, Source, EventDispatcher

public class SOCKSUDPTunnelextends I2PTunnelUDPClientBase

A Datagram Tunnel that can have multiple bidirectional ports on the UDP side.

TX: (multiple SOCKSUDPPorts -> ) I2PSink

RX: (SOCKSUDPWrapper in multiple SOCKSUDPPorts <- ) MultiSink <- I2PSource

The replies must be to the same I2CP toPort as the outbound fromPort. If the server does not honor that, the replies will be dropped.

The replies must be repliable. Raw datagrams are not supported, and would require a unique source port for each target.

Preliminary, untested, possibly incomplete.

Field Summary
Fields
Modifier and Type
Field
Description
private final MultiSink<SOCKSUDPPort>
demuxer
Hands each received datagram to its port.
private final Map<Integer, SOCKSUDPPort>
ports
Open UDP ports, by SOCKS port number.
Fields inherited from class I2PTunnelUDPClientBase
_clientId, _context, l
Modifier and Type
Field
Description
protected long
_clientId
Unique client identifier.
protected I2PAppContext
_context
The I2P app context.
protected Logging
l
Logging instance.
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
SOCKSUDPTunnel(I2PTunnel tunnel)
Set up a tunnel with no UDP side yet.
Method Summary
Modifier and Type
Method
Description
int
add(InetAddress host, int port)
Adds a new UDP port to the tunnel for bidirectional SOCKS UDP communication.
boolean
close(boolean forced)
Closes the tunnel and all associated ports.
void
remove(Integer port)
Removes a UDP port from the tunnel and stops its associated resources.
private void
startall()
You should really add() after startRunning().
final void
startRunning()
Starts the tunnel and begins processing datagrams.
private void
stopall()
Closes every open UDP port.
Methods inherited from class I2PTunnelUDPClientBase
send, setSink, start
Modifier and Type
Method
Description
void
send(Destination to, int fromPort, int toPort, byte[] data)
Sends data through the I2P sink to the configured destination.
void
setSink(Sink s)
Sets the receiver of the UDP datagrams from I2P.
void
start()
Starts the I2P source to begin receiving datagrams.
Methods inherited from class I2PTunnelTask
connected, destroy, disconnected, errorOccurred, getBooleanOption, getId, getSocketManager, getTunnel, isOpen, optionsUpdated, 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.
boolean
destroy()
Note that the tunnel cannot be reopened after this by calling startRunning(), as it may destroy the underlying socket manager, depending on implementation.
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.
I2PSocketManager
getSocketManager()
Returns the I2PSocketManager for this task, or null if not applicable.
I2PTunnel
getTunnel()
The I2PTunnel this task runs inside.
boolean
isOpen()
Whether the tunnel is running and accepting connections.
void
optionsUpdated(I2PTunnel tunnel)
Notify the task that I2PTunnel's options have been updated.
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
- ports
  private final Map<Integer, SOCKSUDPPort> ports
  Open UDP ports, by SOCKS port number.
- demuxer
  private final MultiSink<SOCKSUDPPort> demuxer
  Hands each received datagram to its port.
Constructor Details
- SOCKSUDPTunnel
  public SOCKSUDPTunnel(I2PTunnel tunnel)
  Set up a tunnel with no UDP side yet. Use add() for each port.
  Parameters:
  tunnel - the parent tunnel supplying the logging facility, event dispatcher, I2CP session and client options for the UDP association
Method Details
- add
  public int add(InetAddress host, int port)
  Adds a new UDP port to the tunnel for bidirectional SOCKS UDP communication.
  Parameters:
  host - the local address to bind to
  port - the local port to bind to, or 0 for any available port
  Returns:
  the actual port number the socket was bound to
- remove
  public void remove(Integer port)
  Removes a UDP port from the tunnel and stops its associated resources.
  Parameters:
  port - the UDP port number to remove
- startRunning
  public final void startRunning()
  Starts the tunnel and begins processing datagrams. Ports must be added after this call.
  Overrides:
  startRunning in class I2PTunnelUDPClientBase
- close
  public boolean close(boolean forced)
  Closes the tunnel and all associated ports.
  Overrides:
  close in class I2PTunnelUDPClientBase
  Parameters:
  forced - if true, force immediate close without graceful shutdown
  Returns:
  true if closed successfully
- startall
  private void startall()
  You should really add() after startRunning().
- stopall
  private void stopall()
  Closes every open UDP port.

Field Summary

Fields inherited from class I2PTunnelUDPClientBase

Fields inherited from class I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class I2PTunnelUDPClientBase

Methods inherited from class I2PTunnelTask

Methods inherited from class EventDispatcherImpl

Methods inherited from class Object

Field Details

ports

demuxer

Constructor Details

Method Details

add

remove

startRunning

close

startall

stopall