I2PSessionImpl2 (Javadocs [I2P+ 2.13.0+]

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 I2PSessionImpl2
extends I2PSessionImpl
```
Thread safe implementation of an I2P session running over TCP. Unused directly, see I2PSessionMuxedImpl extension.

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.client.impl.I2PSessionImpl
  I2PSessionImpl.AvailabilityNotifier, I2PSessionImpl.State
- Nested classes/interfaces inherited from interface net.i2p.client.I2PSession
  I2PSession.TunnelPair

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`_noEffort` Don't expect any MSMs from the router for outbound traffic @since 0.8.1
`protected Map<Long,MessageState>`	`_sendingStates` set of MessageState objects, representing all of the messages in the process of being sent
`protected AtomicLong`	`_sendMessageNonce` _sendMessageNonce.

Fields inherited from class net.i2p.client.impl.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

Fields inherited from interface net.i2p.client.I2PSession
PORT_ANY, PORT_UNSPECIFIED, PROTO_ANY, PROTO_DATAGRAM, PROTO_DATAGRAM_RAW, PROTO_DATAGRAM2, PROTO_DATAGRAM3, PROTO_STREAMING, PROTO_UNSPECIFIED

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`I2PSessionImpl2(I2PAppContext ctx, InputStream destKeyStream, Properties options)` 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
`protected`	`I2PSessionImpl2(I2PAppContext context, Properties options, I2PClientMessageHandlerMap handlerMap)` for extension by SimpleSession (no dest)
`protected`	`I2PSessionImpl2(I2PSessionImpl primary, InputStream destKeyStream, Properties options)` I2PSessionImpl2.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMuxedSessionListener(I2PSessionMuxedListener l, int proto, int port)` Not supported.
`void`	`addSessionListener(I2PSessionListener lsnr, int proto, int port)` Not supported.
`void`	`addTunnelStatusListener(TunnelStatusListener lsnr)` Add a listener for tunnel status changes.
`void`	`destroySession(boolean sendDisconnect)` destroySession.
`I2PSession.TunnelPair`	`getCurrentTunnelPair()` getCurrentTunnelPair.
`protected long`	`getTimeout()` Return the timeout value.
`protected void`	`notifyPoolShuttingDown(String poolName, boolean isInbound)` Notify listeners of pool shutdown.
`protected void`	`notifyTunnelFailed(String poolName, boolean isInbound)` Notify listeners of a tunnel failure.
`protected void`	`notifyTunnelRemoved(TunnelRemovalEvent event)` Notify listeners of a tunnel removal.
`void`	`rebuildTunnels()` rebuildTunnels.
`byte[]`	`receiveMessage(int msgId)` pull the unencrypted AND DECOMPRESSED data
`void`	`receiveStatus(int msgId, long nonce, int status)` Only call this with nonzero status, i.e.
`protected boolean`	`reconnect()` Called whenever we want to reconnect (used only in the superclass).
`void`	`removeListener(int proto, int port)` Not supported.
`void`	`removeTunnelStatusListener(TunnelStatusListener lsnr)` removeTunnelStatusListener.
`protected boolean`	`sendBestEffort(Destination dest, byte[] payload, long expires, int flags)` TODO - Don't need to save MessageState since actuallyWait is false...
`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)` sendMessage.
`boolean`	`sendMessage(Destination dest, byte[] payload, int proto, int fromport, int toport)` Not supported.
`boolean`	`sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options)` Not supported.
`long`	`sendMessage(Destination dest, byte[] payload, int offset, int size, int proto, int fromport, int toport, SendMessageOptions options, SendMessageStatusListener listener)` Not supported.
`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)` Not supported.
`boolean`	`sendMessage(Destination dest, byte[] payload, int offset, int size, SessionKey keyUsed, Set<SessionTag> tagsSent, long expires)` Unused? see 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)` Not supported.
`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)` Not supported.
`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(), except we do not expect any MessageStatusMessage responses - not for accepted, or success, or failure.
`void`	`setCurrentTunnelPair(I2PSession.TunnelPair pair)` setCurrentTunnelPair.
`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()` switchToNewTunnel.

Methods inherited from class net.i2p.client.impl.I2PSessionImpl
addNewMessage, addSubsession, bandwidthLimits, bwReceived, changeState, clearCache, connect, dateUpdated, destLookupFailed, destLookupFailed, destReceived, destReceived, destroySession, disconnect, disconnected, getContext, getFastReceive, getHandlerMap, getLastLS2SignTime, getLeaseSet, getMyDestination, getName, getOfflineExpiration, getOfflineSignature, getOptions, getPrefix, getPrivateKey, getProducer, getRouterVersion, getSessionId, getSubsessions, getTransientSigningPublicKey, isClosed, isOffline, lastActivity, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest, lookupDest2, messageReceived, propagateError, readError, removeSubsession, reportAbuse, sendBlindingInfo, sendMessage_unchecked, sendMessage, setLastLS2SignTime, setLeaseSet, setReduced, setSessionId, setSessionListener, shouldReconnect, supportsLS2, toString, updateActivity, updateOptions, verifyOpen, waitForDate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.i2p.client.I2PSession
getDecryptionKey

- Field Detail
  - _noEffort
```
protected boolean _noEffort
```
    Don't expect any MSMs from the router for outbound traffic @since 0.8.1
  - _sendingStates
```
protected final Map<Long,MessageState> _sendingStates
```
    set of MessageState objects, representing all of the messages in the process of being sent
  - _sendMessageNonce
```
protected final AtomicLong _sendMessageNonce
```
    _sendMessageNonce.
- Constructor Detail
  - 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:
    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(I2PAppContext context,
                          Properties options,
                          I2PClientMessageHandlerMap handlerMap)
```
    for extension by SimpleSession (no dest)
  - I2PSessionImpl2
```
protected I2PSessionImpl2(I2PSessionImpl primary,
                          InputStream destKeyStream,
                          Properties options)
                   throws I2PSessionException
```
    I2PSessionImpl2.
    Throws:
    I2PSessionException
- Method Detail
  - addMuxedSessionListener
```
public void addMuxedSessionListener(I2PSessionMuxedListener l,
                                    int proto,
                                    int port)
```
    Not supported.
    Parameters:
    l - the listener to add
    proto - 1-254 or PROTO_ANY (0) for all; 255 disallowed
    port - 1-65535 or PORT_ANY (0) for all
    Throws:
    UnsupportedOperationException - always
  - addSessionListener
```
public void addSessionListener(I2PSessionListener lsnr,
                               int proto,
                               int port)
```
    Not supported.
    Parameters:
    lsnr - the listener to add
    proto - 1-254 or PROTO_ANY (0) for all; recommended: I2PSession.PROTO_STREAMING I2PSession.PROTO_DATAGRAM 255 disallowed
    port - 1-65535 or PORT_ANY (0) for all
    Throws:
    UnsupportedOperationException - always
  - addTunnelStatusListener
```
public void addTunnelStatusListener(TunnelStatusListener lsnr)
```
    Add a listener for tunnel status changes. This is used by the streaming library to react to tunnel failures and removals.
    Parameters:
    lsnr - the listener to add
  - destroySession
```
public void destroySession(boolean sendDisconnect)
```
    destroySession.
    Overrides:
    destroySession in class I2PSessionImpl
    Parameters:
    sendDisconnect - if true, send disconnect message to router
  - getCurrentTunnelPair
```
public I2PSession.TunnelPair getCurrentTunnelPair()
```
    getCurrentTunnelPair.
    Returns:
    TunnelPair containing inbound and outbound tunnel IDs, or null if none
  - getTimeout
```
protected long getTimeout()
```
    Return the timeout value.
    Returns:
    the timeout
  - notifyPoolShuttingDown
```
protected void notifyPoolShuttingDown(String poolName,
                                      boolean isInbound)
```
    Notify listeners of pool shutdown.
  - notifyTunnelFailed
```
protected void notifyTunnelFailed(String poolName,
                                  boolean isInbound)
```
    Notify listeners of a tunnel failure.
  - notifyTunnelRemoved
```
protected void notifyTunnelRemoved(TunnelRemovalEvent event)
```
    Notify listeners of a tunnel removal.
  - rebuildTunnels
```
public void rebuildTunnels()
```
    rebuildTunnels.
  - receiveMessage
```
public byte[] receiveMessage(int msgId)
                      throws I2PSessionException
```
    pull the unencrypted AND DECOMPRESSED data
    Specified by:
    receiveMessage in interface I2PSession
    Overrides:
    receiveMessage in class I2PSessionImpl
    Parameters:
    msgId - message to fetch
    Returns:
    the data, or null on error
    Throws:
    I2PSessionException - on error
  - 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:
    status - != 0
    msgId - the message ID
    nonce - the nonce
  - reconnect
```
protected boolean reconnect()
```
    Called whenever we want to reconnect (used only in the superclass). We need to override this to clear out the message state
    Overrides:
    reconnect in class I2PSessionImpl
    Returns:
    success
  - removeListener
```
public void removeListener(int proto,
                           int port)
```
    Not supported.
    Parameters:
    proto - protocol number
    port - port number
    Throws:
    UnsupportedOperationException - always
  - removeTunnelStatusListener
```
public void removeTunnelStatusListener(TunnelStatusListener lsnr)
```
    removeTunnelStatusListener.
    Parameters:
    lsnr - the listener to remove
  - sendBestEffort
```
protected boolean sendBestEffort(Destination dest,
                                 byte[] payload,
                                 long expires,
                                 int flags)
                          throws I2PSessionException
```
    TODO - Don't need to save MessageState since actuallyWait is false... But for now just use sendNoEffort() instead.
    Parameters:
    dest - the destination
    payload - the payload
    expires - expiration time
    flags - to be passed to the router
    Returns:
    success
    Throws:
    I2PSessionException
  - 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 destination
    payload - the payload
    keyUsed - unused - no end-to-end crypto
    tagsSent - unused - no end-to-end crypto
    expires - expiration time
    Returns:
    success
    Throws:
    I2PSessionException
  - 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 - on error
  - sendMessage
```
public boolean sendMessage(Destination dest,
                           byte[] payload,
                           int offset,
                           int size)
                    throws I2PSessionException
```
    sendMessage.
    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:
    success
    Throws:
    I2PSessionException - on error
  - sendMessage
```
public boolean sendMessage(Destination dest,
                           byte[] payload,
                           int proto,
                           int fromport,
                           int toport)
                    throws I2PSessionException
```
    Not supported.
    Parameters:
    dest - location to send the message
    payload - body of the message to be sent (unencrypted)
    proto - protocol number
    fromport - source port
    toport - destination port
    Returns:
    false always
    Throws:
    UnsupportedOperationException - always
    I2PSessionException - on error
  - sendMessage
```
public boolean sendMessage(Destination dest,
                           byte[] payload,
                           int offset,
                           int size,
                           int proto,
                           int fromport,
                           int toport,
                           SendMessageOptions options)
                    throws I2PSessionException
```
    Not supported.
    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
    I2PSessionException - on error
  - sendMessage
```
public long sendMessage(Destination dest,
                        byte[] payload,
                        int offset,
                        int size,
                        int proto,
                        int fromport,
                        int toport,
                        SendMessageOptions options,
                        SendMessageStatusListener listener)
                 throws I2PSessionException
```
    Not supported.
    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
    I2PSessionException - on all errors
  - 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:
    keyUsed - unused - no end-to-end crypto
    tagsSent - unused - no end-to-end crypto
    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:
    success
    Throws:
    I2PSessionException - on error
  - 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
```
    Not supported.
    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.
    tagsSent - UNUSED, IGNORED.
    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
    I2PSessionException - on error
  - sendMessage
```
public boolean sendMessage(Destination dest,
                           byte[] payload,
                           int offset,
                           int size,
                           SessionKey keyUsed,
                           Set<SessionTag> tagsSent,
                           long expires)
                    throws I2PSessionException
```
    Unused? see MuxedImpl override
    Parameters:
    keyUsed - unused - no end-to-end crypto
    tagsSent - unused - no end-to-end crypto
    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
    expires - absolute expiration timestamp, NOT interval from now
    Returns:
    success
    Throws:
    I2PSessionException - on error
  - 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
```
    Not supported.
    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.
    tagsSent - UNUSED, IGNORED.
    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
    I2PSessionException - on error
  - 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
```
    Not supported.
    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.
    tagsSent - UNUSED, IGNORED.
    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 - message flags
    Returns:
    false always
    Throws:
    UnsupportedOperationException - always
    I2PSessionException - on error
  - sendMessage
```
public boolean sendMessage(Destination dest,
                           byte[] payload,
                           SessionKey keyUsed,
                           Set<SessionTag> tagsSent)
                    throws I2PSessionException
```
    Send a message with session key and tags.
    Parameters:
    keyUsed - unused - no end-to-end crypto
    tagsSent - unused - no end-to-end crypto
    dest - location to send the message
    payload - body of the message to be sent (unencrypted)
    Returns:
    success
    Throws:
    I2PSessionException - on error
  - sendNoEffort
```
protected boolean sendNoEffort(Destination dest,
                               byte[] payload,
                               long expires,
                               int flags)
                        throws I2PSessionException
```
    Same as sendBestEffort(), 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
    Returns:
    true always
    Throws:
    I2PSessionException
  - setCurrentTunnelPair
```
public void setCurrentTunnelPair(I2PSession.TunnelPair pair)
```
    setCurrentTunnelPair.
    Parameters:
    pair - the tunnel pair in use
  - shouldCompress
```
protected boolean shouldCompress(int size)
```
    Return whether compression should be used.
    Returns:
    whether compress
  - startVerifyUsage
```
protected void startVerifyUsage()
```
    Fire up a periodic task to check for unclaimed messages
    Overrides:
    startVerifyUsage in class I2PSessionImpl
  - switchToNewTunnel
```
public boolean switchToNewTunnel()
```
    switchToNewTunnel.
    Returns:
    success

Class I2PSessionImpl2

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.client.impl.I2PSessionImpl

Nested classes/interfaces inherited from interface net.i2p.client.I2PSession

Field Summary

Fields inherited from class net.i2p.client.impl.I2PSessionImpl

Fields inherited from interface net.i2p.client.I2PSession

Constructor Summary

Method Summary

Methods inherited from class net.i2p.client.impl.I2PSessionImpl

Methods inherited from class java.lang.Object

Methods inherited from interface net.i2p.client.I2PSession

Field Detail

_noEffort

_sendingStates

_sendMessageNonce

Constructor Detail

I2PSessionImpl2

I2PSessionImpl2

I2PSessionImpl2

Method Detail

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