OutboundEstablishState (Javadocs [I2P+ 2.13.0+]

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

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

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class OutboundEstablishState.OutboundState
States for outbound SSU session establishment.

Nested Classes
Modifier and Type	Class and Description
`static class`	`OutboundEstablishState.OutboundState` States for outbound SSU session establishment.

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`_aliceIP` Alice's IP
`protected int`	`_alicePort` Alice's port
`protected byte[]`	`_bobIP` Bob's IP
`protected int`	`_bobPort` Bob's port
`protected RouterContext`	`_context` The router context
`protected OutboundEstablishState.OutboundState`	`_currentState` Current state
`protected long`	`_establishBegin` Establish begin time
`protected long`	`_lastSend` Last send time
`protected Log`	`_log` Logger
`protected long`	`_nextSend` Next send time
`protected long`	`_receivedRelayTag` Received relay tag
`protected RemoteHostId`	`_remoteHostId` Remote host ID
`protected RouterIdentity`	`_remotePeer` Remote peer
`protected int`	`_requestSentCount` Request sent count
`protected long`	`_requestSentTime` Request sent time
`protected int`	`_rtt` Round trip time
`protected static long`	`MAX_DELAY` Max delay including backoff (15 seconds)
`protected static long`	`RETRANSMIT_DELAY` Flat delay between all retransmits (no exponential backoff).

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`OutboundEstablishState(RouterContext ctx, RemoteHostId claimedAddress, RemoteHostId remoteHostId, RouterIdentity remotePeer, boolean needIntroduction, SessionKey introKey, UDPAddress addr)` For SSU2

Method Summary

All 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.
`boolean`	`complete()` Mark as complete.
`void`	`confirmedPacketsSent()` note that we just sent the SessionConfirmed packet
`void`	`dataReceived()` we have received a real data packet, so we're done establishing
`void`	`fail()` The SessionCreated validation failed
`(package private) RemoteHostId`	`getClaimedAddress()` This will never be a hash-based address.
`long`	`getConfirmedSentTime()` When we sent the first SessionConfirmed packet.
`long`	`getEstablishBeginTime()`
`SessionKey`	`getIntroKey()` Bob's introduction key, as published in the netdb
`long`	`getIntroNonce()` Get the introduction nonce, or -1 if unset.
`long`	`getIntroSentTime()` When we sent the first RelayRequest packet.
`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?
`OutNetMessage`	`getNextQueuedMessage()` Get the next queued message.
`long`	`getNextSendTime()` The next time a message should be sent.
`byte[]`	`getReceivedIP()`
`int`	`getReceivedPort()`
`long`	`getReceivedRelayTag()`
`long`	`getReceivedSignedOnTime()`
`UDPAddress`	`getRemoteAddress()`
`(package private) RemoteHostId`	`getRemoteHostId()` This should be what the state is currently indexed by in the _outboundStates table.
`RouterIdentity`	`getRemoteIdentity()`
`long`	`getRequestSentTime()` When we sent the first SessionRequest packet.
`(package private) int`	`getRTT()`
`byte[]`	`getSentIP()` The remote side (Bob) - note that in some places he's called Charlie.
`int`	`getSentPort()` The remote side (Bob) - note that in some places he's called Charlie.
`long`	`getSentSignedOnTime()`
`OutboundEstablishState.OutboundState`	`getState()`
`int`	`getVersion()` Get the version of the SSU protocol in use.
`void`	`introduced(byte[] bobIP, int bobPort)` This changes the remoteHostId from a hash-based one or possibly incorrect IP/port to what the introducer told us.
`void`	`introductionFailed()` introductionFailed.
`void`	`introSent()` note that we just sent the RelayRequest packet
`boolean`	`isExtendedOptionsAllowed()` Are we allowed to send extended options to this peer?
`boolean`	`isFirstMessageOurDSM()` Is the first message queued our own DatabaseStoreMessage?
`boolean`	`needIntroduction()` Should we ask this peer to be an introducer for us? Ignored unless allowExtendedOptions is true
`protected void`	`packetReceived()` Call from synchronized method only
`(package private) boolean`	`receiveHolePunch()` Accelerate response to RelayResponse if we haven't sent it yet.
`void`	`requestSent()` note that we just sent the SessionRequest packet
`void`	`setIntroNonce(long nonce)`
`String`	`toString()` Get string representation
`boolean`	`validateSessionCreated()` Blocking call (run in the establisher thread) to determine if the session was created properly.

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

- Field Detail
  - _aliceIP
```
protected byte[] _aliceIP
```
    Alice's IP
  - _alicePort
```
protected int _alicePort
```
    Alice's port
  - _bobIP
```
protected byte[] _bobIP
```
    Bob's IP
  - _bobPort
```
protected int _bobPort
```
    Bob's port
  - _context
```
protected final RouterContext _context
```
    The router context
  - _currentState
```
protected OutboundEstablishState.OutboundState _currentState
```
    Current state
  - _establishBegin
```
protected final long _establishBegin
```
    Establish begin time
  - _lastSend
```
protected long _lastSend
```
    Last send time
  - _log
```
protected final Log _log
```
    Logger
  - _nextSend
```
protected long _nextSend
```
    Next send time
  - _receivedRelayTag
```
protected long _receivedRelayTag
```
    Received relay tag
  - _remoteHostId
```
protected RemoteHostId _remoteHostId
```
    Remote host ID
  - _remotePeer
```
protected final RouterIdentity _remotePeer
```
    Remote peer
  - _requestSentCount
```
protected int _requestSentCount
```
    Request sent count
  - _requestSentTime
```
protected long _requestSentTime
```
    Request sent time
  - _rtt
```
protected int _rtt
```
    Round trip time
  - MAX_DELAY
```
protected static final long MAX_DELAY
```
    Max delay including backoff (15 seconds)
    See Also:
    Constant Field Values
  - RETRANSMIT_DELAY
```
protected static final long RETRANSMIT_DELAY
```
    Flat delay between all retransmits (no exponential backoff). Handshake packets are tiny (~200B) and infrequent per-peer, so the bandwidth cost of flat retransmission is negligible. The OB_MESSAGE_TIMEOUT (2.5s) bounds total retransmits per establishment phase. Was 1000ms with exponential doubling (max gap 16s). Reduced to 500ms, now 200ms for sub-100ms message delivery.
- Constructor Detail
  - OutboundEstablishState
```
protected OutboundEstablishState(RouterContext ctx,
                                 RemoteHostId claimedAddress,
                                 RemoteHostId remoteHostId,
                                 RouterIdentity remotePeer,
                                 boolean needIntroduction,
                                 SessionKey introKey,
                                 UDPAddress addr)
```
    For SSU2
    Parameters:
    ctx - the router context
    claimedAddress - the claimed address from the netdb
    remoteHostId - the remote host ID
    remotePeer - the remote peer identity
    needIntroduction - whether introduction is needed
    introKey - the introduction key
    addr - the UDP address
- Method Detail
  - addMessage
```
public void addMessage(OutNetMessage msg)
```
    Queue a message to be sent after the session is established.
    Parameters:
    msg - the message to queue
  - complete
```
public boolean complete()
```
    Mark as complete.
    Returns:
    whether it was previously complete
  - confirmedPacketsSent
```
public void confirmedPacketsSent()
```
    note that we just sent the SessionConfirmed packet
  - dataReceived
```
public void dataReceived()
```
    we have received a real data packet, so we're done establishing
  - fail
```
public void fail()
```
    The SessionCreated validation failed
  - getClaimedAddress
```
RemoteHostId getClaimedAddress()
```
    This will never be a hash-based address. This is the 'claimed' (unverified) address from the netdb, or null. It is not changed after introduction. Use getRemoteHostId() for the verified address.
    Returns:
    may be null
  - getConfirmedSentTime
```
public long getConfirmedSentTime()
```
    When we sent the first SessionConfirmed packet.
    Returns:
    the time, or 0 if not yet sent
  - getEstablishBeginTime
```
public long getEstablishBeginTime()
```
    Returns:
    the establish begin time
  - getIntroKey
```
public SessionKey getIntroKey()
```
    Bob's introduction key, as published in the netdb
    Returns:
    the intro key
  - getIntroNonce
```
public long getIntroNonce()
```
    Get the introduction nonce, or -1 if unset.
    Returns:
    the nonce, or -1
  - getIntroSentTime
```
public long getIntroSentTime()
```
    When we sent the first RelayRequest packet.
    Returns:
    the time, or 0 if not yet sent
  - getLifetime
```
public long getLifetime()
```
    How long have we been trying to establish this session?
    Returns:
    the lifetime in milliseconds
  - getLifetime
```
public long getLifetime(long now)
```
    How long have we been trying to establish this session?
    Parameters:
    now - the current time
    Returns:
    the lifetime in milliseconds
  - getNextQueuedMessage
```
public OutNetMessage getNextQueuedMessage()
```
    Get the next queued message.
    Returns:
    the next queued message, or null if none
  - getNextSendTime
```
public long getNextSendTime()
```
    The next time a message should be sent.
    Returns:
    0 at initialization (to force sending session request), rcv time after receiving a packet, send time + delay after sending a packet (including session request)
  - getReceivedIP
```
public byte[] getReceivedIP()
```
    Returns:
    the received IP
  - getReceivedPort
```
public int getReceivedPort()
```
    Returns:
    the received port
  - getReceivedRelayTag
```
public long getReceivedRelayTag()
```
    Returns:
    the received relay tag
  - getReceivedSignedOnTime
```
public long getReceivedSignedOnTime()
```
    Returns:
    the received signed-on time
  - getRemoteAddress
```
public UDPAddress getRemoteAddress()
```
    Returns:
    the remote address
  - getRemoteHostId
```
RemoteHostId getRemoteHostId()
```
    This should be what the state is currently indexed by in the _outboundStates table. Beware - During introduction, this is a router hash. After introduced() is called, this is set to the IP/port the introducer told us.
    Returns:
    non-null
  - getRemoteIdentity
```
public RouterIdentity getRemoteIdentity()
```
    Returns:
    the remote identity
  - getRequestSentTime
```
public long getRequestSentTime()
```
    When we sent the first SessionRequest packet.
    Returns:
    the time, or 0 if not yet sent
  - getRTT
```
int getRTT()
```
    Returns:
    the RTT
  - getSentIP
```
public byte[] getSentIP()
```
    The remote side (Bob) - note that in some places he's called Charlie. Warning - may change after introduction. May be null before introduction.
    Returns:
    the sent IP, or null
  - getSentPort
```
public int getSentPort()
```
    The remote side (Bob) - note that in some places he's called Charlie. Warning - may change after introduction. May be -1 before introduction.
    Returns:
    the sent port, or -1
  - getSentSignedOnTime
```
public long getSentSignedOnTime()
```
    Returns:
    the sent signed-on time
  - getState
```
public OutboundEstablishState.OutboundState getState()
```
    Returns:
    the current outbound state
  - getVersion
```
public int getVersion()
```
    Get the version of the SSU protocol in use.
    Returns:
    the protocol version
  - introduced
```
public void introduced(byte[] bobIP,
                       int bobPort)
```
    This changes the remoteHostId from a hash-based one or possibly incorrect IP/port to what the introducer told us. All params are for the remote end (NOT the introducer) and must have been validated already.
    Parameters:
    bobIP - the remote IP
    bobPort - the remote port
  - introductionFailed
```
public void introductionFailed()
```
    introductionFailed.
  - introSent
```
public void introSent()
```
    note that we just sent the RelayRequest packet
  - isExtendedOptionsAllowed
```
public boolean isExtendedOptionsAllowed()
```
    Are we allowed to send extended options to this peer?
    Returns:
    true if allowed
  - isFirstMessageOurDSM
```
public boolean isFirstMessageOurDSM()
```
    Is the first message queued our own DatabaseStoreMessage?
    Returns:
    true if the first queued message is our DSM
  - needIntroduction
```
public boolean needIntroduction()
```
    Should we ask this peer to be an introducer for us? Ignored unless allowExtendedOptions is true
    Returns:
    true if introduction is needed
  - packetReceived
```
protected void packetReceived()
```
    Call from synchronized method only
  - receiveHolePunch
```
boolean receiveHolePunch()
```
    Accelerate response to RelayResponse if we haven't sent it yet.
    Returns:
    true if we should send the SessionRequest now
  - requestSent
```
public void requestSent()
```
    note that we just sent the SessionRequest packet
  - setIntroNonce
```
public void setIntroNonce(long nonce)
```
    Parameters:
    nonce - the introduction nonce
  - toString
```
public String toString()
```
    Get string representation
    Overrides:
    toString in class Object
  - validateSessionCreated
```
public boolean validateSessionCreated()
```
    Blocking call (run in the establisher thread) to determine if the session was created properly. If it wasn't, all the SessionCreated remnants are dropped (perhaps they were spoofed, etc) so that we can receive another one Generates session key and mac key.
    Returns:
    true if valid

Class OutboundEstablishState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_aliceIP

_alicePort

_bobIP

_bobPort

_context

_currentState

_establishBegin

_lastSend

_log

_nextSend

_receivedRelayTag

_remoteHostId

_remotePeer

_requestSentCount

_requestSentTime

_rtt

MAX_DELAY

RETRANSMIT_DELAY

Constructor Detail

OutboundEstablishState

Method Detail

addMessage

complete

confirmedPacketsSent

dataReceived

fail

getClaimedAddress

getConfirmedSentTime

getEstablishBeginTime

getIntroKey

getIntroNonce

getIntroSentTime

getLifetime

getLifetime

getNextQueuedMessage

getNextSendTime

getReceivedIP

getReceivedPort

getReceivedRelayTag

getReceivedSignedOnTime

getRemoteAddress

getRemoteHostId

getRemoteIdentity

getRequestSentTime

getRTT

getSentIP

getSentPort

getSentSignedOnTime

getState

getVersion

introduced

introductionFailed

introSent

isExtendedOptionsAllowed

isFirstMessageOurDSM

needIntroduction

packetReceived

receiveHolePunch

requestSent

setIntroNonce

toString

validateSessionCreated