I2PSessionImpl2

java.lang.Object

net.i2p.client.impl.I2PSessionImpl

net.i2p.client.impl.I2PSessionImpl2

All Implemented Interfaces:: I2PSession, I2CPMessageReader.I2CPMessageEventListener

Direct Known Subclasses:: I2PSessionMuxedImpl, I2PSimpleSession

class I2PSessionImpl2extends I2PSessionImpl

Thread safe implementation of an I2P session running over TCP.

Unused directly, see I2PSessionMuxedImpl extension.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private class
I2PSessionImpl2.RemoveExpired
Check for expired message states, without wastefully setting a timer for each message.
Nested classes/interfaces inherited from class I2PSessionImpl
I2PSessionImpl.AvailabilityNotifier, I2PSessionImpl.State
Modifier and Type
Class
Description
protected class
I2PSessionImpl.AvailabilityNotifier
This notifies the client of payload messages.
protected static enum
I2PSessionImpl.State
Session state enumeration.
Nested classes/interfaces inherited from interface I2PSession
I2PSession.TunnelPair
Modifier and Type
Interface
Description
static class
I2PSession.TunnelPair
Simple holder for tunnel pair information.
Field Summary
Fields
Modifier and Type
Field
Description
private I2PSession.TunnelPair
_currentTunnelPair
The tunnels carrying this session now.
protected boolean
_noEffort
Don't expect any MSMs from the router for outbound traffic.
protected final Map<Long, MessageState>
_sendingStates
One MessageState object per message in the process of being sent.
protected final AtomicLong
_sendMessageNonce
Source of the per-message replay nonces sent to the router.
private static Method
_tunnelManagerMethod
Reflected accessor for the tunnel manager.
private static final int
DONT_COMPRESS_SIZE
Don't bother if really small.
private static final long
REMOVE_EXPIRED_TIME
How often expired leases are dropped - every 63 seconds.
private static final long
SEND_TIMEOUT
Max # seconds to wait for confirmation of the message send.
private static final boolean
SHOULD_COMPRESS
Should we gzip each payload prior to sending it?
private static final boolean
SHOULD_DECOMPRESS
Whether the router may send compressed lease sets.
Fields inherited from class I2PSessionImpl
_availabilityNotifier, _availableMessages, _bwLimits, _bwReceivedLock, _context, _handlerMap, _hostname, _leaseSet, _leaseSetWait, _log, _pendingLookups, _portNum, _producer, _queue, _reader, _sessionListener, _socket, _state, _stateLock, _transientSigningPublicKey, _tunnelStatusListeners, _writer, CACHE_MAX_SIZE, DUMMY_SESSION, LISTEN_PORT, PROP_DOMAIN_SOCKET
Modifier and Type
Field
Description
protected I2PSessionImpl.AvailabilityNotifier
_availabilityNotifier
Thread that we tell when new messages are available, who then tells us to fetch them.
protected Map<Long, MessagePayloadMessage>
_availableMessages
Map of Long--> MessagePayloadMessage.
protected int[]
_bwLimits
Current bandwidth limits.
protected final Object
_bwReceivedLock
Lock for bandwidth limit updates.
protected final I2PAppContext
_context
App context, kept separate so we can get rid of singletons.
protected final I2PClientMessageHandlerMap
_handlerMap
Handler map for I2CP message types.
protected final String
_hostname
Hostname of router - will be null if in RouterContext.
protected LeaseSet
_leaseSet
Currently granted lease set, or null.
protected final Object
_leaseSetWait
Monitor for waiting until a lease set has been granted.
protected final Log
_log
Logger for this session.
protected final LinkedBlockingQueue<I2PSessionImpl.LookupWaiter>
_pendingLookups
Hashes of lookups we are waiting for.
protected final int
_portNum
Port number of router - will be 0 if in RouterContext.
protected final I2CPMessageProducer
_producer
Class that generates new messages.
protected I2CPMessageQueue
_queue
Used for internal connections to the router.
protected I2CPMessageReader
_reader
Reader that always searches for messages.
protected I2PSessionListener
_sessionListener
Where session events are sent.
protected Socket
_socket
Socket for communication.
protected I2PSessionImpl.State
_state
Current session state.
protected final Object
_stateLock
Lock for state transitions.
protected SigningPublicKey
_transientSigningPublicKey
Transient signing public key for offline signatures.
protected final Set<TunnelStatusListener>
_tunnelStatusListeners
Listeners for tunnel status changes (tunnel failures and removals).
protected ClientWriterRunner
_writer
Writer message queue.
protected static final int
CACHE_MAX_SIZE
Maximum size of the lookup cache.
(package private) static final SessionId
DUMMY_SESSION
Dummy session ID for messages before a real session is established.
static final int
LISTEN_PORT
Default I2CP listen port.
protected static final String
PROP_DOMAIN_SOCKET
Use Unix domain socket (or similar) to connect to a router.
Fields inherited from interface I2PSession
PORT_ANY, PORT_UNSPECIFIED, PROTO_ANY, PROTO_DATAGRAM, PROTO_DATAGRAM_RAW, PROTO_DATAGRAM2, PROTO_DATAGRAM3, PROTO_STREAMING, PROTO_UNSPECIFIED
Modifier and Type
Field
Description
static final int
PORT_ANY
Any port.
static final int
PORT_UNSPECIFIED
Unspecified port.
static final int
PROTO_ANY
Any protocol.
static final int
PROTO_DATAGRAM
A repliable and signed datagram.
static final int
PROTO_DATAGRAM_RAW
A raw (unsigned, unrepliable) datagram.
static final int
PROTO_DATAGRAM2
A repliable and signed datagram.
static final int
PROTO_DATAGRAM3
A repliable but unsigned datagram.
static final int
PROTO_STREAMING
Streaming protocol.
static final int
PROTO_UNSPECIFIED
Unspecified protocol.
Constructor Summary
Constructors
Modifier
Constructor
Description
protected
I2PSessionImpl2(I2PSessionImpl primary, InputStream destKeyStream, Properties options)
For extension by SubSession via I2PSessionMuxedImpl
protected
I2PSessionImpl2(I2PAppContext ctx, InputStream destKeyStream, Properties options)
For extension by I2PSessionMuxedImpl
protected
I2PSessionImpl2(I2PAppContext context, Properties options, I2PClientMessageHandlerMap handlerMap)
For extension by SimpleSession (no dest).
Method Summary
Modifier and Type
Method
Description
void
addMuxedSessionListener(I2PSessionMuxedListener l, int proto, int port)
Register a muxed session listener.
void
addSessionListener(I2PSessionListener lsnr, int proto, int port)
Register a session listener.
void
addTunnelStatusListener(TunnelStatusListener lsnr)
Register a tunnel status listener.
private void
clearStates()
Clear all pending message states.
void
destroySession(boolean sendDisconnect)
Destroy the I2P session, after clearing the message send states.
I2PSession.TunnelPair
getCurrentTunnelPair()
Return the current tunnel pair.
protected long
getTimeout()
Wait this long for the router to accept a sent message, in ms.
private Object
getTunnelManager()
Cached reflection access to RouterContext.tunnelManager().
protected void
notifyPoolShuttingDown(String poolName, boolean isInbound)
Notify all tunnel status listeners of pool shutdown.
protected void
notifyTunnelFailed(String poolName, boolean isInbound)
Notify all tunnel status listeners of a tunnel failure.
protected void
notifyTunnelRemoved(TunnelRemovalEvent event)
Notify all tunnel status listeners of a tunnel removal.
void
rebuildTunnels()
Rebuild the tunnel set.
byte[]
receiveMessage(int msgId)
Receive a message from the router, decompressing it unless it was sent uncompressed.
void
receiveStatus(int msgId, long nonce, int status)
Only call this with nonzero status, i.e.
protected boolean
reconnect()
Reconnect the I2CP session.
void
removeListener(int proto, int port)
Remove a registered listener.
void
removeTunnelStatusListener(TunnelStatusListener lsnr)
Remove a tunnel status listener.
protected boolean
sendBestEffort(Destination dest, byte[] payload, long expires, int flags)
Send a best-effort message with the given flags.
protected boolean
sendBestEffort(Destination dest, byte[] payload, SessionKey keyUsed, Set<SessionTag> tagsSent, long expires)
Send a message with best effort delivery.
boolean
sendMessage(Destination dest, byte[] payload)
Unused, see MuxedImpl override.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, int proto, int fromport, int toport)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options)
Send an I2CP message.
long
sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options, SendMessageStatusListener listener)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent)
Send a message with session key and tags.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, int proto, int fromport, int toport)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expires)
Unused? See the MuxedImpl override.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expire, int proto, int fromport, int toport)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expire, int proto, int fromport, int toport, int flags)
Send an I2CP message.
boolean
sendMessage(Destination dest, byte[] payload, SessionKey keyUsed, Set<SessionTag> tagsSent)
Send a message with session key and tags.
protected boolean
sendNoEffort(Destination dest, byte[] payload, long expires, int flags)
Same as sendBestEffort(Destination, byte[], SessionKey, Set, long), except we do not expect any MessageStatusMessage responses - not for accepted, or success, or failure.
void
setCurrentTunnelPair(I2PSession.TunnelPair pair)
Current tunnel pair in use.
protected boolean
shouldCompress(int size)
Return whether compression should be used.
protected void
startVerifyUsage()
Fire up a periodic task to check for unclaimed messages.
boolean
switchToNewTunnel()
Switch to the new tunnel set.
Methods inherited from class I2PSessionImpl
addNewMessage, addSubsession, bandwidthLimits, bwReceived, changeState, clearCache, connect, dateUpdated, destLookupFailed, destLookupFailed, destReceived, destReceived, destroySession, discardMessage, disconnect, disconnected, getContext, getFastReceive, getHandlerMap, getLastLS2SignTime, getLeaseSet, getMyDestination, getName, getOfflineExpiration, getOfflineSignature, getOptions, getPrefix, getPrivateKey, getProducer, getRouterVersion, getSessionId, getSubsessions, getTransientSigningPublicKey, getTunnelBuildTimeout, isClosed, isOffline, lastActivity, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest2, messageReceived, propagateError, readError, removeSubsession, reportAbuse, sendBlindingInfo, sendMessage, sendMessage_unchecked, setLastLS2SignTime, setLeaseSet, setReduced, setSessionId, setSessionListener, shouldReconnect, supportsLS2, toString, updateActivity, updateOptions, verifyOpen, waitForDate
Modifier and Type
Method
Description
void
addNewMessage(MessagePayloadMessage msg)
Receive a payload message and let the app know its available.
I2PSession
addSubsession(InputStream privateKeyStream, Properties opts)
Router must be connected or was connected...
int[]
bandwidthLimits()
Blocking.
(package private) void
bwReceived(int[] limits)
Called by the message handler.
protected void
changeState(I2PSessionImpl.State state)
Change the session state.
static void
clearCache()
Clear the lookup cache.
void
connect()
Connect to the router and establish a session.
(package private) void
dateUpdated(String routerVersion)
Update the router version and related feature support flags.
(package private) void
destLookupFailed(long nonce, int code)
Called by the message handler on reception of HostReplyMessage.
(package private) void
destLookupFailed(Hash h)
Called by the message handler on reception of DestReplyMessage.
(package private) void
destReceived(long nonce, Destination d)
Called by the message handler on reception of HostReplyMessage.
(package private) void
destReceived(Destination d)
Called by the message handler on reception of DestReplyMessage.
void
destroySession()
Tear down the session, and do NOT reconnect.
void
discardMessage(int msgId)
Throw away the received message, we don't want it.
protected void
disconnect()
Will interrupt a connect in progress.
void
disconnected(I2CPMessageReader reader)
The I2CPMessageEventListener callback.
(package private) I2PAppContext
getContext()
For Subsessions.
boolean
getFastReceive()
Does this session support fast receive?
(package private) I2PClientMessageHandlerMap
getHandlerMap()
For Subsessions.
(package private) long
getLastLS2SignTime()
The published timestamp of the last LS2 we signed.
LeaseSet
getLeaseSet()
Current lease set published by this session.
Destination
getMyDestination()
Retrieve the destination of the session.
protected String
getName()
Session name for logging.
long
getOfflineExpiration()
Java time (ms) or 0 if not initialized or does not have offline keys.
Signature
getOfflineSignature()
Null on error or if not initialized or does not have offline keys.
Properties
getOptions()
Retrieve the configuration options, filtered.
protected final String
getPrefix()
Try hard to make a decent identifier as this will appear in error logs.
SigningPrivateKey
getPrivateKey()
Retrieve the signing SigningPrivateKey.
(package private) I2CPMessageProducer
getProducer()
Retrieve the helper that generates I2CP messages.
String
getRouterVersion()
Always valid in RouterContext.
(package private) SessionId
getSessionId()
Retrieve the session's ID.
List<I2PSession>
getSubsessions()
List of subsessions, non-null, does not include the primary session.
SigningPublicKey
getTransientSigningPublicKey()
Null on error or if not initialized or does not have offline keys.
(package private) static int
getTunnelBuildTimeout(String sessionValue, String contextValue)
Parse the tunnel build timeout, shared with the instance method and tests.
boolean
isClosed()
Has the session been closed (or not yet connected)? False when open and during transitions.
boolean
isOffline()
Does this session have offline and transient keys?
long
lastActivity()
Time of last session activity in milliseconds.
Destination
lookupDest(String name)
Ask the router to lookup a Destination by host name.
Destination
lookupDest(String name, long maxWait)
Ask the router to lookup a Destination by host name.
LookupResult
lookupDest(String name, long maxWait, LookupCallback callback)
Lookup a Destination by hash.
Destination
lookupDest(Hash h)
Blocking.
Destination
lookupDest(Hash h, long maxWait)
Blocking.
LookupResult
lookupDest(Hash h, long maxWait, LookupCallback callback)
Lookup a Destination by hostname.
LookupResult
lookupDest2(String name, long maxWait)
Ask the router to lookup a Destination by host name.
void
messageReceived(I2CPMessageReader reader, I2CPMessage message)
The I2CPMessageEventListener callback.
(package private) void
propagateError(String msg, Throwable error)
Pass off the error to the listener Misspelled, oh well.
void
readError(I2CPMessageReader reader, Exception error)
The I2CPMessageEventListener callback.
void
removeSubsession(I2PSession session)
No-op, this session has no subsessions.
void
reportAbuse(int msgId, int severity)
Report abuse with regards to the given messageId.
void
sendBlindingInfo(BlindData bd)
Send blinding info to a peer.
(package private) void
sendMessage(I2CPMessage message)
Deliver an I2CP message to the router As of 0.9.3, may block for several seconds if the write queue to the router is full.
(package private) void
sendMessage_unchecked(I2CPMessage message)
Deliver an I2CP message to the router.
(package private) void
setLastLS2SignTime(long now)
The published timestamp of the last LS2 we signed.
(package private) void
setLeaseSet(LeaseSet ls)
Lease set published by this session.
void
setReduced()
Mark the session as reduced.
(package private) void
setSessionId(SessionId id)
Session ID assigned by the router.
void
setSessionListener(I2PSessionListener lsnr)
Configure the listener.
protected boolean
shouldReconnect()
Whether the session should attempt reconnection on disconnect.
boolean
supportsLS2()
Does this session support LS2?
String
toString()

protected void
updateActivity()
Update the last activity timestamp.
void
updateOptions(Properties options)
Update the tunnel and bandwidth settings.
protected void
verifyOpen()
Throws I2PSessionException if uninitialized, closed or closing.
protected void
waitForDate()
Wait for a SetDate response from the router.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface I2PSession
getDecryptionKey
Modifier and Type
Method
Description
PrivateKey
getDecryptionKey()
Retrieve the decryption PrivateKey associated with the Destination.

Field Details
- _sendingStates
  protected final Map<Long, MessageState> _sendingStates
  One MessageState object per message in the process of being sent.
- _sendMessageNonce
  protected final AtomicLong _sendMessageNonce
  Source of the per-message replay nonces sent to the router.
- SEND_TIMEOUT
  private static final long SEND_TIMEOUT
  Max # seconds to wait for confirmation of the message send.
  See Also:
  Constant Field Values
- SHOULD_COMPRESS
  private static final boolean SHOULD_COMPRESS
  Should we gzip each payload prior to sending it?
  See Also:
  Constant Field Values
- SHOULD_DECOMPRESS
  private static final boolean SHOULD_DECOMPRESS
  Whether the router may send compressed lease sets.
  See Also:
  Constant Field Values
- _noEffort
  protected boolean _noEffort
  Don't expect any MSMs from the router for outbound traffic.
- REMOVE_EXPIRED_TIME
  private static final long REMOVE_EXPIRED_TIME
  How often expired leases are dropped - every 63 seconds.
  See Also:
  Constant Field Values
- _tunnelManagerMethod
  private static Method _tunnelManagerMethod
  Reflected accessor for the tunnel manager.
- DONT_COMPRESS_SIZE
  private static final int DONT_COMPRESS_SIZE
  Don't bother if really small. Three 66-byte messages will fit in one tunnel message. Four messages don't fit no matter how small. So below 66 it isn't worth it. See ConnectionOptions.java in the streaming lib for similar calculations.
  Since we still have to pass it through gzip -0 the CPU savings is trivial but it's the best we can do for now. See below. i2cp.gzip defaults to SHOULD_COMPRESS = true.
  Perhaps the http server (which does its own compression) and P2P apps (with generally uncompressible data) should set to false.
  See Also:
  Constant Field Values
- _currentTunnelPair
  private volatile I2PSession.TunnelPair _currentTunnelPair
  The tunnels carrying this session now.
Constructor Details
- I2PSessionImpl2
  protected I2PSessionImpl2(I2PAppContext context, Properties options, I2PClientMessageHandlerMap handlerMap)
  For extension by SimpleSession (no dest).
  Parameters:
  context - the app context whose router client the session sends through
  options - router connection options, or null to use the System properties
  handlerMap - the map the session registers its incoming-message handlers in
- I2PSessionImpl2
  protected I2PSessionImpl2(I2PAppContext ctx, InputStream destKeyStream, Properties options) throws I2PSessionException
  For extension by I2PSessionMuxedImpl
  Create a new session, reading the Destination, PrivateKey, and SigningPrivateKey from the destKeyStream, and using the specified options to connect to the router.
  Parameters:
  ctx - the app context whose router client the session sends through
  destKeyStream - stream containing the private key data, format is specified in PrivateKeyFile
  options - set of options to configure the router with, if null will use System properties
  Throws:
  I2PSessionException - if there is a problem loading the private keys
- I2PSessionImpl2
  protected I2PSessionImpl2(I2PSessionImpl primary, InputStream destKeyStream, Properties options) throws I2PSessionException
  For extension by SubSession via I2PSessionMuxedImpl
  Create a new session, reading the Destination, PrivateKey, and SigningPrivateKey from the destKeyStream, and using the specified options to connect to the router.
  Parameters:
  primary - the muxed session whose context, handlers and producer are shared
  destKeyStream - stream containing the private key data, format is specified in PrivateKeyFile
  options - set of options to configure the router with, if null will use System properties
  Throws:
  I2PSessionException - if the destination key stream cannot be read or parsed
Method Details
- startVerifyUsage
  protected void startVerifyUsage()
  Fire up a periodic task to check for unclaimed messages.
  Overrides:
  startVerifyUsage in class I2PSessionImpl
- getTimeout
  protected long getTimeout()
  Wait this long for the router to accept a sent message, in ms.
  Returns:
  milliseconds to wait for the router to accept the message
- destroySession
  public void destroySession(boolean sendDisconnect)
  Destroy the I2P session, after clearing the message send states.
  Overrides:
  destroySession in class I2PSessionImpl
  Parameters:
  sendDisconnect - if true, send a disconnect message to the router
- shouldCompress
  protected boolean shouldCompress(int size)
  Return whether compression should be used.
  Parameters:
  size - the uncompressed message size in bytes, compared to 66
  Returns:
  true if the message should be compressed before sending
- addSessionListener
  public void addSessionListener(I2PSessionListener lsnr, int proto, int port)
  Register a session listener. Not supported by this implementation - use I2PSessionMuxedImpl, which demultiplexes by protocol and port.
  Parameters:
  lsnr - the listener
  proto - ignored - this implementation registers no listeners
  port - ignored - this implementation registers no listeners
  Throws:
  UnsupportedOperationException - always, as listeners are unsupported here
- addMuxedSessionListener
  public void addMuxedSessionListener(I2PSessionMuxedListener l, int proto, int port)
  Register a muxed session listener. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  l - the listener
  proto - ignored - this implementation registers no listeners
  port - ignored - this implementation registers no listeners
  Throws:
  UnsupportedOperationException - always, as listeners are unsupported here
- removeListener
  public void removeListener(int proto, int port)
  Remove a registered listener. Not supported by this implementation - nothing is ever registered here.
  Parameters:
  proto - ignored - nothing is ever registered here
  port - ignored - nothing is ever registered here
  Throws:
  UnsupportedOperationException - always, as no listener is ever registered
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int proto, int fromport, int toport) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  proto - 1-254, or 0 for unset; 255 disallowed
  fromport - source port, 1-65535 or 0 for unset
  toport - destination port, 1-65535 or 0 for unset
  Returns:
  false always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, int proto, int fromport, int toport) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  keyUsed - UNUSED, IGNORED, as end-to-end crypto is disabled
  tagsSent - UNUSED, IGNORED, as end-to-end crypto is disabled
  proto - 1-254 or 0 for unset; recommended: I2PSession.PROTO_UNSPECIFIED I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
  fromport - 1-65535 or 0 for unset
  toport - 1-65535 or 0 for unset
  Returns:
  false always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expire, int proto, int fromport, int toport) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  keyUsed - UNUSED, IGNORED, as end-to-end crypto is disabled
  tagsSent - UNUSED, IGNORED, as end-to-end crypto is disabled
  expire - absolute expiration timestamp, NOT interval from now
  proto - 1-254 or 0 for unset; recommended: I2PSession.PROTO_UNSPECIFIED I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
  fromport - 1-65535 or 0 for unset
  toport - 1-65535 or 0 for unset
  Returns:
  false always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expire, int proto, int fromport, int toport, int flags) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  keyUsed - UNUSED, IGNORED, as end-to-end crypto is disabled
  tagsSent - UNUSED, IGNORED, as end-to-end crypto is disabled
  expire - absolute expiration timestamp, NOT interval from now
  proto - 1-254 or 0 for unset; recommended: I2PSession.PROTO_UNSPECIFIED I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
  fromport - 1-65535 or 0 for unset
  toport - 1-65535 or 0 for unset
  flags - packed SendMessageOptions bits to send with the message
  Returns:
  false always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  proto - 1-254 or 0 for unset; recommended: I2PSession.PROTO_UNSPECIFIED I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
  fromport - 1-65535 or 0 for unset
  toport - 1-65535 or 0 for unset
  options - to be passed to the router
  Returns:
  false always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public long sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options, SendMessageStatusListener listener) throws I2PSessionException
  Send an I2CP message. Not supported by this implementation - use I2PSessionMuxedImpl.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  proto - 1-254 or 0 for unset; recommended: I2PSession.PROTO_UNSPECIFIED I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
  fromport - 1-65535 or 0 for unset
  toport - 1-65535 or 0 for unset
  options - to be passed to the router
  listener - for delivery status notification
  Returns:
  -1 always
  Throws:
  UnsupportedOperationException - always, as muxed sends are unsupported here
  I2PSessionException - on all errors
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload) throws I2PSessionException
  Unused, see MuxedImpl override.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  Returns:
  whether it was accepted by the router for delivery or not
  Throws:
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size) throws I2PSessionException
  Send an I2CP message. No end-to-end crypto is done, so any key or tags are ignored; this delegates to the no-effort/best-effort send below.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, SessionKey keyUsed, Set<SessionTag> tagsSent) throws I2PSessionException
  Send a message with session key and tags.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  keyUsed - unused - no end-to-end crypto
  tagsSent - unused - no end-to-end crypto
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent) throws I2PSessionException
  Send a message with session key and tags.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  keyUsed - unused - no end-to-end crypto
  tagsSent - unused - no end-to-end crypto
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- sendMessage
  public boolean sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expires) throws I2PSessionException
  Unused? See the MuxedImpl override.
  Parameters:
  dest - location to send the message
  payload - body of the message to be sent (unencrypted)
  offset - offset into the payload
  size - number of bytes to send
  keyUsed - unused - no end-to-end crypto
  tagsSent - unused - no end-to-end crypto
  expires - absolute expiration timestamp, NOT interval from now
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the session is not open or closed, or the write queue stays full
- receiveMessage
  public byte[] receiveMessage(int msgId) throws I2PSessionException
  Receive a message from the router, decompressing it unless it was sent uncompressed.
  Specified by:
  receiveMessage in interface I2PSession
  Overrides:
  receiveMessage in class I2PSessionImpl
  Parameters:
  msgId - the message ID
  Returns:
  the data, or null on error
  Throws:
  I2PSessionException - declared but never thrown; failures return null instead
- sendBestEffort
  protected boolean sendBestEffort(Destination dest, byte[] payload, SessionKey keyUsed, Set<SessionTag> tagsSent, long expires) throws I2PSessionException
  Send a message with best effort delivery.
  Parameters:
  dest - the remote destination to send to
  payload - the message bytes to deliver
  keyUsed - unused - no end-to-end crypto
  tagsSent - unused - no end-to-end crypto
  expires - expiration time in ms since the epoch, 0 for the router default
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the wait for the router's status update is interrupted
- sendBestEffort
  protected boolean sendBestEffort(Destination dest, byte[] payload, long expires, int flags) throws I2PSessionException
  Send a best-effort message with the given flags.
  Parameters:
  dest - the remote destination to send to
  payload - the message bytes to deliver
  expires - expiration time in ms since the epoch, 0 for the router default
  flags - to be passed to the router
  Returns:
  whether the router accepted the message for delivery
  Throws:
  I2PSessionException - if the wait for the router's status update is interrupted
- sendNoEffort
  protected boolean sendNoEffort(Destination dest, byte[] payload, long expires, int flags) throws I2PSessionException
  Same as sendBestEffort(Destination, byte[], SessionKey, Set, long), except we do not expect any MessageStatusMessage responses - not for accepted, or success, or failure. So we don't create a MessageState and save it on the _sendingStates HashSet.
  Parameters:
  dest - the remote destination to send to
  payload - the message bytes
  expires - expiration time in ms since the epoch, 0 for the router default
  flags - to be passed to the router
  Returns:
  true always
  Throws:
  I2PSessionException - if the router rejects the send
- receiveStatus
  public void receiveStatus(int msgId, long nonce, int status)
  Only call this with nonzero status, i.e. for outbound messages whose MessageState may be queued on _sendingStates.
  Even when using sendBestEffort(), this is a waste, because the MessageState is removed from _sendingStates immediately and so the lookup here fails.
  This is now pretty much avoided since streaming now sets i2cp.messageReliability = none, which forces sendNoEffort() instead of sendBestEffort(), so the router won't send us any MSM's for outbound traffic.
  Specified by:
  receiveStatus in class I2PSessionImpl
  Parameters:
  msgId - the message ID
  nonce - the nonce identifying the send
  status - != 0
- reconnect
  protected boolean reconnect()
  Reconnect the I2CP session. Called by the superclass whenever it wants to reconnect; overridden to also clear out the message state.
  Overrides:
  reconnect in class I2PSessionImpl
  Returns:
  whether the session was reconnected
- clearStates
  private void clearStates()
  Clear all pending message states.
- getTunnelManager
  private Object getTunnelManager()
  Cached reflection access to RouterContext.tunnelManager(). Method is looked up once and reused to avoid repeated getMethod() overhead.
  Returns:
  the tunnel manager
- addTunnelStatusListener
  public void addTunnelStatusListener(TunnelStatusListener lsnr)
  Register a tunnel status listener. In a router context the listener is also registered with the TunnelPoolManager, if there is one.
  Parameters:
  lsnr - the listener
- removeTunnelStatusListener
  public void removeTunnelStatusListener(TunnelStatusListener lsnr)
  Remove a tunnel status listener.
  Parameters:
  lsnr - the listener
- switchToNewTunnel
  public boolean switchToNewTunnel()
  Switch to the new tunnel set. Not supported by this implementation.
  Returns:
  false always
- setCurrentTunnelPair
  public void setCurrentTunnelPair(I2PSession.TunnelPair pair)
  Current tunnel pair in use.
  Parameters:
  pair - the tunnel pair in use
- getCurrentTunnelPair
  public I2PSession.TunnelPair getCurrentTunnelPair()
  Return the current tunnel pair.
  Returns:
  the current tunnel pair, or null if none
- rebuildTunnels
  public void rebuildTunnels()
  Rebuild the tunnel set.
- notifyTunnelFailed
  protected void notifyTunnelFailed(String poolName, boolean isInbound)
  Notify all tunnel status listeners of a tunnel failure.
  Parameters:
  poolName - the pool the failed tunnel belonged to
  isInbound - true if the tunnel was an inbound one
- notifyTunnelRemoved
  protected void notifyTunnelRemoved(TunnelRemovalEvent event)
  Notify all tunnel status listeners of a tunnel removal.
  Parameters:
  event - identifies the removed tunnel, its pool, direction and the reason
- notifyPoolShuttingDown
  protected void notifyPoolShuttingDown(String poolName, boolean isInbound)
  Notify all tunnel status listeners of pool shutdown.
  Parameters:
  poolName - the pool being shut down
  isInbound - true if the pool builds inbound tunnels

Nested Class Summary

Nested classes/interfaces inherited from class I2PSessionImpl

Nested classes/interfaces inherited from interface I2PSession

Field Summary

Fields inherited from class I2PSessionImpl

Fields inherited from interface I2PSession

Constructor Summary

Method Summary

Methods inherited from class I2PSessionImpl

Methods inherited from class Object

Methods inherited from interface I2PSession

Field Details

_sendingStates

_sendMessageNonce

SEND_TIMEOUT

SHOULD_COMPRESS

SHOULD_DECOMPRESS

_noEffort

REMOVE_EXPIRED_TIME

_tunnelManagerMethod

DONT_COMPRESS_SIZE

_currentTunnelPair

Constructor Details

I2PSessionImpl2

I2PSessionImpl2

Method Details

startVerifyUsage

getTimeout

destroySession

shouldCompress

addSessionListener

addMuxedSessionListener

removeListener

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

sendMessage

receiveMessage

sendBestEffort

sendBestEffort

sendNoEffort

receiveStatus

reconnect

clearStates

getTunnelManager

addTunnelStatusListener

removeTunnelStatusListener

switchToNewTunnel

setCurrentTunnelPair

getCurrentTunnelPair

rebuildTunnels

notifyTunnelFailed

notifyTunnelRemoved

notifyPoolShuttingDown