I2PTunnelUDPClientBase

net.i2p.i2ptunnel.udpTunnel.I2PTunnelUDPClientBase

All Implemented Interfaces:: Sink, Source, EventDispatcher

Direct Known Subclasses:: SOCKSUDPTunnel, StreamrConsumer

public abstract class I2PTunnelUDPClientBaseextends I2PTunnelTask implements Source, Sink

Base client class that sets up an I2P Datagram client destination. The UDP side is not implemented here, as there are at least two possibilities:

1) UDP side is a "server" Example: Streamr Consumer - Configure a destination host and port - External application sends no data - Extending class must have a constructor with host and port arguments

2) UDP side is a client/server Example: SOCKS UDP (DNS requests?) - configure an inbound port and a destination host and port - External application sends and receives data - Extending class must have a constructor with host and 2 port arguments

So the implementing class must create a UDPSource and/or UDPSink, and must call setSink(Sink).

Field Summary
Fields
Modifier and Type
Field
Description
private static final AtomicLong
__clientId
Counts the client ids handed out.
protected long
_clientId
Unique client identifier.
protected I2PAppContext
_context
The I2P app context.
private final Sink
_i2pSink
Sends datagrams out over I2P.
private final Source
_i2pSource
Reads datagrams arriving from I2P.
private final I2PSession
_session
The session carrying the datagrams.
(package private) static final long
DEFAULT_CONNECT_TIMEOUT
Default connect timeout.
protected Logging
l
Logging instance.
private final Object
startLock
Guards starting the destination's sockets.
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
I2PTunnelUDPClientBase(String destination, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel)
Set up the I2P client, destination keypair, and I2CP session for this tunnel.
Method Summary
All Methods
Modifier and Type
Method
Description
boolean
close(boolean forced)
Closes the tunnel and destroys the session.
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.
void
startRunning()
Starts the tunnel and begins processing 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
- _context
  protected I2PAppContext _context
  The I2P app context.
- l
  protected Logging l
  Logging instance.
- DEFAULT_CONNECT_TIMEOUT
  static final long DEFAULT_CONNECT_TIMEOUT
  Default connect timeout.
  See Also:
  Constant Field Values
- __clientId
  private static final AtomicLong __clientId
  Counts the client ids handed out.
- _clientId
  protected long _clientId
  Unique client identifier.
- startLock
  private final Object startLock
  Guards starting the destination's sockets.
- _session
  private final I2PSession _session
  The session carrying the datagrams.
- _i2pSource
  private final Source _i2pSource
  Reads datagrams arriving from I2P.
- _i2pSink
  private final Sink _i2pSink
  Sends datagrams out over I2P.
Constructor Details
- I2PTunnelUDPClientBase
  public I2PTunnelUDPClientBase(String destination, Logging l, EventDispatcher notifyThis, I2PTunnel tunnel) throws IllegalArgumentException
  Set up the I2P client, destination keypair, and I2CP session for this tunnel.
  Parameters:
  destination - I2P destination to send to; null for send-to-anyone
  l - the logging facility used for this tunnel's output
  notifyThis - event dispatcher for notifications
  tunnel - the parent tunnel, supplying the context and I2CP options
  Throws:
  IllegalArgumentException - if the I2CP configuration is so broken that we can't create a socketManager
Method Details
- startRunning
  public void startRunning()
  Starts the tunnel and begins processing datagrams. Classes should override to start UDP side as well.
- close
  public boolean close(boolean forced)
  Closes the tunnel and destroys the session.
  Specified by:
  close in class I2PTunnelTask
  Parameters:
  forced - if true, force immediate close without graceful shutdown
  Returns:
  true if closed successfully
- setSink
  public void setSink(Sink s)
  Sets the receiver of the UDP datagrams from I2P. Subclass must call this after constructor and before start().
  Specified by:
  setSink in interface Source
  Parameters:
  s - the sink to receive incoming datagrams
- start
  public void start()
  Starts the I2P source to begin receiving datagrams.
  Specified by:
  start in interface Source
- send
  public void send(Destination to, int fromPort, int toPort, byte[] data)
  Sends data through the I2P sink to the configured destination.
  Specified by:
  send in interface Sink
  Parameters:
  to - the destination to send to, ignored if configured for a single destination
  fromPort - I2CP source port, 0-65535
  toPort - I2CP destination port, 0-65535
  data - the data to send
  Throws:
  RuntimeException - if the session is closed

Field Summary

Fields inherited from class I2PTunnelTask

Constructor Summary

Method Summary

Methods inherited from class I2PTunnelTask

Methods inherited from class EventDispatcherImpl

Methods inherited from class Object

Field Details

_context

l

DEFAULT_CONNECT_TIMEOUT

__clientId

_clientId

startLock

_session

_i2pSource

_i2pSink

Constructor Details

Method Details

startRunning

close

setSink

start

send