I2PSimpleSession

net.i2p.client.impl.I2PSimpleSession

All Implemented Interfaces:: I2PSession, I2CPMessageReader.I2CPMessageEventListener

public class I2PSimpleSessionextends I2PSessionImpl2

Create a new session for doing naming and bandwidth queries only. Do not create a Destination. Don't create a producer. Do not send/receive messages to other Destinations. Cannot handle multiple simultaneous queries atm. Could be expanded to ask the router other things.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private static class
I2PSimpleSession.SimpleMessageHandlerMap
Only map message handlers that we will use.
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 static final int
BUF_SIZE
Size of the stream copy buffer, in bytes.
Fields inherited from class I2PSessionImpl2
_noEffort, _sendingStates, _sendMessageNonce
Modifier and Type
Field
Description
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.
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
Constructor
Description
I2PSimpleSession(I2PAppContext context, Properties options)
Create a new session for doing naming and bandwidth queries only.
Method Summary
All Methods
Modifier and Type
Method
Description
void
connect()
Connect to the router and establish a session.
void
updateOptions(Properties options)
Ignore, does nothing.
Methods inherited from class I2PSessionImpl2
addMuxedSessionListener, addSessionListener, addTunnelStatusListener, destroySession, getCurrentTunnelPair, getTimeout, notifyPoolShuttingDown, notifyTunnelFailed, notifyTunnelRemoved, rebuildTunnels, receiveMessage, receiveStatus, reconnect, removeListener, removeTunnelStatusListener, sendBestEffort, sendBestEffort, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendNoEffort, setCurrentTunnelPair, shouldCompress, startVerifyUsage, switchToNewTunnel
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.
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.
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 I2PSessionImpl2.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, 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, 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.
(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.
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
- BUF_SIZE
  private static final int BUF_SIZE
  Size of the stream copy buffer, in bytes.
  See Also:
  Constant Field Values
Constructor Details
- I2PSimpleSession
  public I2PSimpleSession(I2PAppContext context, Properties options) throws I2PSessionException
  Create a new session for doing naming and bandwidth queries only. Do not create a destination.
  Parameters:
  context - the application context the session and its message handlers are built around
  options - set of options to configure the router with, if null will use System properties
  Throws:
  I2PSessionException - if there is a problem
Method Details
- connect
  public void connect() throws I2PSessionException
  Connect to the router and establish a session. This call blocks until a session is granted.
  NOT threadsafe, do not call from multiple threads.
  Specified by:
  connect in interface I2PSession
  Overrides:
  connect in class I2PSessionImpl
  Throws:
  I2PSessionException - if there is a configuration error or the router is not reachable
- updateOptions
  public void updateOptions(Properties options)
  Ignore, does nothing.
  Specified by:
  updateOptions in interface I2PSession
  Overrides:
  updateOptions in class I2PSessionImpl
  Parameters:
  options - non-null

Nested Class Summary

Nested classes/interfaces inherited from class I2PSessionImpl

Nested classes/interfaces inherited from interface I2PSession

Field Summary

Fields inherited from class I2PSessionImpl2

Fields inherited from class I2PSessionImpl

Fields inherited from interface I2PSession

Constructor Summary

Method Summary

Methods inherited from class I2PSessionImpl2

Methods inherited from class I2PSessionImpl

Methods inherited from class Object

Methods inherited from interface I2PSession

Field Details

BUF_SIZE

Constructor Details

Method Details

connect

updateOptions