InboundEstablishState (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.transport.udp.InboundEstablishState

Direct Known Subclasses:
InboundEstablishState2
```
class InboundEstablishState
extends Object
```
Data for a new connection being established, where the remote peer has initiated the connection with us. In other words, they are Alice and we are Bob.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class InboundEstablishState.InboundState
States for inbound SSU session establishment.

Nested Classes
Modifier and Type	Class and Description
`static class`	`InboundEstablishState.InboundState` States for inbound SSU session establishment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`_aliceIP` Alice's IP address from the SessionCreated message
`protected int`	`_alicePort` Alice's port number
`protected byte[]`	`_bobIP` Our IP address as seen by Alice
`protected int`	`_bobPort` Our port number as seen by Alice
`protected RouterContext`	`_context` Router context
`protected int`	`_createdSentCount` Count of SessionCreated packets sent (for exponential backoff)
`protected InboundEstablishState.InboundState`	`_currentState` Current state in the inbound establishment protocol
`protected long`	`_establishBegin` Timestamp when establishment began
`protected boolean`	`_introductionRequested` Whether Alice requested introduction (default true for SSU 1, false for SSU 2)
`protected long`	`_lastSend` Last packet send time
`protected Log`	`_log` Logger
`protected long`	`_nextSend` Next scheduled send time
`protected RouterIdentity`	`_receivedConfirmedIdentity` Identity after successful signature verification
`protected RouterIdentity`	`_receivedUnconfirmedIdentity` Identity before signature verification
`protected RemoteHostId`	`_remoteHostId` Remote host identifier for uniqueness
`protected int`	`_rtt` Estimated round-trip time
`protected long`	`_sentRelayTag` Relay tag we sent to Alice
`protected static long`	`RETRANSMIT_DELAY` Basic delay before backoff Transmissions at 0, 1, 3, 7 sec.

Constructor Summary
Constructors
Modifier Constructor and Description
protected InboundEstablishState(RouterContext ctx, InetSocketAddress addr)
For SSU2

Constructors
Modifier	Constructor and Description
`protected`	`InboundEstablishState(RouterContext ctx, InetSocketAddress addr)` For SSU2

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMessage(OutNetMessage msg)` Queue a message to be sent after the session is established.
`void`	`complete()` Notify successful completion of the inbound session establishment.
`protected boolean`	`confirmedFullyReceived()` Have we fully received the SessionConfirmed messages from Alice? Caller must synchronize on this.
`void`	`createdPacketSent()` Record that a SessionCreated packet was just sent, update backoff state.
`void`	`fail()` Mark this establishment attempt as failed.
`RouterIdentity`	`getConfirmedIdentity()` The confirmed identity of Alice (null if forged/unknown).
`long`	`getEstablishBeginTime()` The wall clock time when this establishment attempt began.
`long`	`getLifetime()` How long have we been trying to establish this session?
`long`	`getLifetime(long now)` How long have we been trying to establish this session, using the given time.
`protected static long`	`getMaxDelay()` Max delay including backoff.
`OutNetMessage`	`getNextQueuedMessage()` Pull from the message queue
`long`	`getNextSendTime()` The next time at which we should send a packet for this establishment.
`byte[]`	`getReceivedOurIP()` Our IP address as reported by Alice in the SessionRequest.
`byte[]`	`getReceivedX()` The received X value from Alice's SessionRequest message.
`(package private) RemoteHostId`	`getRemoteHostId()` The RemoteHostId that uniquely identifies this establishment attempt.
`(package private) int`	`getRTT()` The estimated round-trip time for this establishment.
`byte[]`	`getSentIP()` Alice's apparent IP address.
`int`	`getSentPort()` Alice's apparent port number.
`long`	`getSentRelayTag()` The relay tag we sent to Alice in the SessionCreated message.
`long`	`getSentSignedOnTime()` The signed-on time we sent to Alice.
`InboundEstablishState.InboundState`	`getState()` Current state of the inbound session establishment.
`int`	`getVersion()` Return the SSU protocol version for this state (always 1 for SSU1).
`boolean`	`isComplete()` Check if the inbound establish state is complete.
`boolean`	`isIntroductionRequested()` Whether Alice requested an introduction.
`protected void`	`packetReceived()` Update the next send time to now, as we just received a packet.
`boolean`	`sessionRequestReceived()` Whether the SessionRequest message has been received from Alice.
`void`	`setSentRelayTag(long tag)` Set the relay tag to include in the SessionCreated message.
`String`	`toString()` Return a human-readable description of this establish state.

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

- Field Detail
  - _aliceIP
```
protected final byte[] _aliceIP
```
    Alice's IP address from the SessionCreated message
  - _alicePort
```
protected final int _alicePort
```
    Alice's port number
  - _bobIP
```
protected byte[] _bobIP
```
    Our IP address as seen by Alice
  - _bobPort
```
protected final int _bobPort
```
    Our port number as seen by Alice
  - _context
```
protected final RouterContext _context
```
    Router context
  - _createdSentCount
```
protected int _createdSentCount
```
    Count of SessionCreated packets sent (for exponential backoff)
  - _currentState
```
protected InboundEstablishState.InboundState _currentState
```
    Current state in the inbound establishment protocol
  - _establishBegin
```
protected final long _establishBegin
```
    Timestamp when establishment began
  - _introductionRequested
```
protected boolean _introductionRequested
```
    Whether Alice requested introduction (default true for SSU 1, false for SSU 2)
  - _lastSend
```
protected long _lastSend
```
    Last packet send time
  - _log
```
protected final Log _log
```
    Logger
  - _nextSend
```
protected long _nextSend
```
    Next scheduled send time
  - _receivedConfirmedIdentity
```
protected RouterIdentity _receivedConfirmedIdentity
```
    Identity after successful signature verification
  - _receivedUnconfirmedIdentity
```
protected RouterIdentity _receivedUnconfirmedIdentity
```
    Identity before signature verification
  - _remoteHostId
```
protected final RemoteHostId _remoteHostId
```
    Remote host identifier for uniqueness
  - _rtt
```
protected int _rtt
```
    Estimated round-trip time
  - _sentRelayTag
```
protected long _sentRelayTag
```
    Relay tag we sent to Alice
  - RETRANSMIT_DELAY
```
protected static final long RETRANSMIT_DELAY
```
    Basic delay before backoff Transmissions at 0, 1, 3, 7 sec. This should be a little shorter than for outbound.
- Constructor Detail
  - InboundEstablishState
```
protected InboundEstablishState(RouterContext ctx,
                                InetSocketAddress addr)
```
    For SSU2
- Method Detail
  - addMessage
```
public void addMessage(OutNetMessage msg)
```
    Queue a message to be sent after the session is established. This will only happen if we decide to send something during establishment
  - complete
```
public void complete()
```
    Notify successful completion of the inbound session establishment.
  - confirmedFullyReceived
```
protected boolean confirmedFullyReceived()
```
    Have we fully received the SessionConfirmed messages from Alice? Caller must synchronize on this.
    Returns:
    true if all fragments have been received
  - createdPacketSent
```
public void createdPacketSent()
```
    Record that a SessionCreated packet was just sent, update backoff state.
  - fail
```
public void fail()
```
    Mark this establishment attempt as failed.
  - getConfirmedIdentity
```
public RouterIdentity getConfirmedIdentity()
```
    The confirmed identity of Alice (null if forged/unknown). Note that this isn't really confirmed - see below.
    Returns:
    Alice's RouterIdentity, or null
  - getEstablishBeginTime
```
public long getEstablishBeginTime()
```
    The wall clock time when this establishment attempt began.
    Returns:
    the start timestamp
  - getLifetime
```
public long getLifetime()
```
    How long have we been trying to establish this session?
    Returns:
    the elapsed time in milliseconds
  - getLifetime
```
public long getLifetime(long now)
```
    How long have we been trying to establish this session, using the given time.
    Parameters:
    now - the reference time
    Returns:
    the elapsed time in milliseconds
  - getMaxDelay
```
protected static long getMaxDelay()
```
    Max delay including backoff. This should be a little shorter than for outbound.
    Returns:
    the max delay
  - getNextQueuedMessage
```
public OutNetMessage getNextQueuedMessage()
```
    Pull from the message queue
    Returns:
    null if none
  - getNextSendTime
```
public long getNextSendTime()
```
    The next time at which we should send a packet for this establishment. Returns the receive time after receiving a packet (including after constructor), or the send time plus backoff delay after sending a packet.
    Returns:
    the next scheduled send time
  - getReceivedOurIP
```
public byte[] getReceivedOurIP()
```
    Our IP address as reported by Alice in the SessionRequest.
    Returns:
    our IP bytes or null
  - getReceivedX
```
public byte[] getReceivedX()
```
    The received X value from Alice's SessionRequest message.
    Returns:
    session request data or null
  - getRemoteHostId
```
RemoteHostId getRemoteHostId()
```
    The RemoteHostId that uniquely identifies this establishment attempt.
    Returns:
    the remote host identifier
  - getRTT
```
int getRTT()
```
    The estimated round-trip time for this establishment.
    Returns:
    the RTT in milliseconds
  - getSentIP
```
public byte[] getSentIP()
```
    Alice's apparent IP address.
    Returns:
    the IP address Alice appears to be connecting from
  - getSentPort
```
public int getSentPort()
```
    Alice's apparent port number.
    Returns:
    the port Alice appears to be connecting from
  - getSentRelayTag
```
public long getSentRelayTag()
```
    The relay tag we sent to Alice in the SessionCreated message.
    Returns:
    the relay tag, or 0 if not yet sent
  - getSentSignedOnTime
```
public long getSentSignedOnTime()
```
    The signed-on time we sent to Alice.
    Returns:
    the signed-on timestamp
  - getState
```
public InboundEstablishState.InboundState getState()
```
    Current state of the inbound session establishment.
    Returns:
    the current InboundState
  - getVersion
```
public int getVersion()
```
    Return the SSU protocol version for this state (always 1 for SSU1).
    Returns:
    the protocol version
  - isComplete
```
public boolean isComplete()
```
    Check if the inbound establish state is complete.
    Returns:
    true if complete or failed
  - isIntroductionRequested
```
public boolean isIntroductionRequested()
```
    Whether Alice requested an introduction. True by default if no extended options in session request, or the value of the introduction flag bit in the extended options.
    Returns:
    true if introduction was requested
  - packetReceived
```
protected void packetReceived()
```
    Update the next send time to now, as we just received a packet. Must call from synchronized method only.
  - sessionRequestReceived
```
public boolean sessionRequestReceived()
```
    Whether the SessionRequest message has been received from Alice.
    Returns:
    true if the initial request has arrived
  - setSentRelayTag
```
public void setSentRelayTag(long tag)
```
    Set the relay tag to include in the SessionCreated message.
    Parameters:
    tag - the relay tag
  - toString
```
public String toString()
```
    Return a human-readable description of this establish state.
    Overrides:
    toString in class Object
    Returns:
    debug string with peer address, lifetime, relay tag, and state

Class InboundEstablishState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_aliceIP

_alicePort

_bobIP

_bobPort

_context

_createdSentCount

_currentState

_establishBegin

_introductionRequested

_lastSend

_log

_nextSend

_receivedConfirmedIdentity

_receivedUnconfirmedIdentity

_remoteHostId

_rtt

_sentRelayTag

RETRANSMIT_DELAY

Constructor Detail

InboundEstablishState

Method Detail

addMessage

complete

confirmedFullyReceived

createdPacketSent

fail

getConfirmedIdentity

getEstablishBeginTime

getLifetime

getLifetime

getMaxDelay

getNextQueuedMessage

getNextSendTime

getReceivedOurIP

getReceivedX

getRemoteHostId

getRTT

getSentIP

getSentPort

getSentRelayTag

getSentSignedOnTime

getState

getVersion

isComplete

isIntroductionRequested

packetReceived

sessionRequestReceived

setSentRelayTag

toString