PeerState2

java.lang.Object

net.i2p.router.transport.udp.PeerState

net.i2p.router.transport.udp.PeerState2

All Implemented Interfaces:: SSU2Bitfield.Callback, SSU2Payload.PayloadCallback, SSU2Sender

public class PeerState2extends PeerState implements SSU2Payload.PayloadCallback, SSU2Bitfield.Callback, SSU2Sender

Contain all of the state about a UDP connection to a peer. This is instantiated only after a connection is fully established.

Public only for UI peers page. Not a public API, not for external use.

SSU2 only.

Nested Class Summary
Nested Classes
Modifier and Type
Class
Description
private class
PeerState2.ACKTimer
A timer to send an ack-only packet.
(package private) static enum
PeerState2.MigrationPendingDecision
Decision of the connection-migration classifier for MIGRATION_STATE_PENDING.
private static enum
PeerState2.MigrationState
State of one SSU2 connection migration.
Nested classes/interfaces inherited from class PeerState
PeerState.FastRtxMode, PeerState.Outcome
Modifier and Type
Class
Description
(package private) static enum
PeerState.FastRtxMode
Fast-retransmit recovery stage for a single message, by NACK count.
(package private) static enum
PeerState.Outcome
Result of classifying one outbound message during a finishAndAllocate() scan over _outboundMessages.
Field Summary
Modifier and Type
Field
Description
private final SSU2Bitfield
_ackedMessages
PS1 has _ackedMessages which is a map of message ID to sequence number.
private final PeerState2.ACKTimer
_ackTimer
Timer scheduling acks and retransmits.
private int
_destroyReason
Reason code for destroying this state.
private final AtomicInteger
_lastAckHashCode
Hash of the last ack sent, to skip duplicates.
private final Object
_migrationLock
Lock for the connection migration state.
private long
_migrationNextSendTime
When the next migration path challenge is due.
private long
_migrationStarted
When the current migration started.
private PeerState2.MigrationState
_migrationState
Current connection migration state.
private byte[]
_ourIP
Our IP as the peer sees it.
private int
_ourPort
Our port as the peer sees it.
private final AtomicLong
_packetNumber
Next SSU2 packet number to send.
private byte[]
_pathChallengeData
Data of the path challenge we sent.
private long
_pathChallengeSendCount
Path challenges sent for the current migration.
private RemoteHostId
_pendingRemoteHostId
New host id pending confirmation during migration.
private final CipherState
_rcvCha
ChaCha20 state for decrypting received packets.
private final long
_rcvConnID
Connection id we receive with.
private final byte[]
_rcvHeaderEncryptKey1
First header encryption key for receiving.
private final byte[]
_rcvHeaderEncryptKey2
Second header encryption key for receiving.
private final SSU2Bitfield
_receivedMessages
Bitfield of received message numbers.
private final CipherState
_sendCha
ChaCha20 state for encrypting sent packets.
private final long
_sendConnID
Connection id we send with.
private final byte[]
_sendHeaderEncryptKey1
First header encryption key for sending.
private final byte[]
_sendHeaderEncryptKey2
Second header encryption key for sending.
private final ConcurrentHashMap<Long, List<PacketBuilder2.Fragment>>
_sentMessages
Sent messages awaiting acks, by message id.
private static long
_sentMessagesCleanTime
Configurable sent-messages sweep interval.
private final ArrayDeque<Map.Entry<Long, List<PacketBuilder2.Fragment>>>
_sentMessagesExpiryCursor
Incremental expiry cursor over a snapshot of _sentMessages, so a tick examines a bounded number of entries instead of the whole map.
private long
_sentMessagesLastExpired
When sent messages were last expired.
private byte[][]
_sessConfForReTX
Session Confirmed packets held for retransmission.
private int
_sessConfSentCount
Session Confirmed retransmit attempts so far.
private long
_sessConfSentTime
When a Session Confirmed was last sent.
private static final int
BITFIELD_SIZE
Message numbers tracked in the received bitfield.
static final int
DEFAULT_MTU
MTU advertised unless the profile overrides it.
static final int
DEFAULT_SSU_IPV4_MTU
DEFAULT_SSU_IPV4_MTU.
static final int
DEFAULT_SSU_IPV6_MTU
DEFAULT_SSU_IPV6_MTU.
static final int
MAX_MTU
Largest MTU we will advertise to SSU2 peers, in bytes.
private static final long
MAX_PACKET_NUMBER
Last usable outbound packet number, see getNextPacketNumber().
(package private) static final int
MAX_PATH_CHALLENGE_SENDS
Path challenge retransmissions before the migration is declared expired.
(package private) static final long
MAX_PATH_CHALLENGE_TIME
Total time a path challenge may span, in ms, before it is declared expired.
private static final int
MAX_SESS_CONF_RETX
Session Confirmed retransmits before giving up.
static final int
MAX_SSU_IPV4_MTU
MAX_SSU_IPV4_MTU.
static final int
MAX_SSU_IPV6_MTU
MAX_SSU_IPV6_MTU.
static final int
MIN_MLKEM768_IPV4_MTU
MIN_MLKEM768_IPV4_MTU.
static final int
MIN_MLKEM768_IPV6_MTU
MIN_MLKEM768_IPV6_MTU.
static final int
MIN_MTU
Smallest MTU we will advertise to SSU2 peers, in bytes.
static final int
MIN_SSU_IPV4_MTU
MIN_SSU_IPV4_MTU.
static final int
MIN_SSU_IPV6_MTU
MIN_SSU_IPV6_MTU.
(package private) static final long
PATH_CHALLENGE_DELAY
Base interval between path challenge sends in ms, doubled per retransmission.
private static final int
SENT_MESSAGES_EXPIRE_BATCH
Max _sentMessages entries examined per expireSentMessages(long) call.
Fields inherited from class PeerState
_context, _dead, _inboundLock, _inboundMessages, _isInbound, _keyEstablishedTime, _lastACKSend, _log, _mtu, _packetsReceivedDuplicate, _remoteHostId, _remoteIP, _remoteIPAddress, _remotePeer, _remotePort, _rtt, _shortHash, _transport, _wantACKSendSince, CONGESTION_COOLDOWN_MIN_MS, LARGE_MTU, MAX_INBOUND_MESSAGES, MAX_IPV6_MTU, MAX_SEND_WINDOW_CEILING, MIN_IPV6_MTU, PATH_UNVERIFIED_FREEZE_MS, RETRANSMISSION_PERIOD_WIDTH
Modifier and Type
Field
Description
protected final RouterContext
_context
The router context.
protected boolean
_dead
Have we migrated away from this peer to another newer one?
protected final Object
_inboundLock
Lock for inbound operations.
protected final ConcurrentMap<Long, InboundMessageState>
_inboundMessages
List of InboundMessageState for active messages.
protected final boolean
_isInbound
Is it inbound?
protected final long
_keyEstablishedTime
The key establishment time.
protected long
_lastACKSend
When did we last send ACKs to the peer?
protected final Log
_log
The log.
protected int
_mtu
What is the largest packet we can currently send to the peer?
protected int
_packetsReceivedDuplicate
How many duplicate packets were received within the last RETRANSMISSION_PERIOD_WIDTH packets.
protected RemoteHostId
_remoteHostId
Cached RemoteHostId, used to find the peerState by remote info.
protected final byte[]
_remoteIP
What IP is the peer sending and receiving packets on?
protected InetAddress
_remoteIPAddress
Cached IP address.
protected final Hash
_remotePeer
The peer are we talking to.
protected int
_remotePort
What port is the peer sending and receiving packets on?
protected int
_rtt
Current round trip time estimate.
protected final String
_shortHash
Six-char base64 prefix of the remote peer hash, pre-computed for log messages (the full encode per log line was hot on floodfills).
protected final UDPTransport
_transport
The UDP transport.
protected long
_wantACKSendSince
When did we decide we need to ACK to this peer?
(package private) static final long
CONGESTION_COOLDOWN_MIN_MS
Floor on the gap between full congestion responses (ms).
static final int
LARGE_MTU
IPv4 maximum MTU.
(package private) static final int
MAX_INBOUND_MESSAGES
Hard cap on partially-received inbound messages held per peer.
static final int
MAX_IPV6_MTU
IPv6 maximum MTU.
(package private) static final int
MAX_SEND_WINDOW_CEILING
Heap-scaled CWIN ceiling: 1MB minimum, up to 16MB, roughly 1MB per 256MB of heap.
static final int
MIN_IPV6_MTU
IPv6 minimum MTU.
(package private) static final long
PATH_UNVERIFIED_FREEZE_MS
How long send-window growth stays frozen after a path-unverified migration signal (ms).
(package private) static final long
RETRANSMISSION_PERIOD_WIDTH
How many packets will be considered within the retransmission rate calculation.
Constructor Summary
Constructors
Constructor
Description
PeerState2(RouterContext ctx, UDPTransport transport, InetSocketAddress remoteAddress, Hash remotePeer, boolean isInbound, int rtt, CipherState sendCha, CipherState rcvCha, long sendID, long rcvID, byte[] sendHdrKey1, byte[] sendHdrKey2, byte[] rcvHdrKey2)
A session with a remote peer over SSU2: the connection ids, the four cipher states and the header encryption keys are all fixed here, so the transport can build one without a separate handshake step.
Method Summary
Modifier and Type
Method
Description
void
bitSet(long pktNum)
Callback from SSU2Bitfield.forEachAndNot(SSU2Bitfield, SSU2Bitfield.Callback).
(package private) void
changeAddress(RemoteHostId id)
Caller should sync; UDPTransport must remove and add to peersByRemoteHost map.
private boolean
checkRetransmitSessionConfirmed(long now, boolean force)
Only call for outbound, if we don't have ack 0 yet.
private boolean
checkRetransmitSessionConfirmed2(long now, boolean force)
Only call for outbound, if we don't have ack 0 yet.
(package private) void
clearWantedACKSendSince()
All acks have been sent.
(package private) void
confirmedPacketsSent(byte[][] data)
Note that we just sent the SessionConfirmed packets and save them for retransmission.
(package private) static PeerState2.MigrationPendingDecision
decidePendingMigration(long now, boolean fromIsRemote, boolean fromIsPending, long migrationStarted, long sendCount, long nextSendTime)
Classify what to do with a packet received while the connection is in MIGRATION_STATE_PENDING.
(package private) void
dropOutbound()
Overridden to also clear sent-but-unacked fragments and cancel ACKTimer.
private void
expireSentMessages(long now)
Expire complete or timed-out entries from _sentMessages, walking an incremental cursor instead of rescanning the whole map and every fragment list on every tick.
(package private) List<OutboundMessageState>
finishAndAllocate(long now)
Single-pass combined cleanup + send allocation, overriding the base class to incorporate SSU2-specific _sentMessages cleanup and SessionConfirmed retransmit logic.
(package private) int
fragmentOverhead()
Packet overhead This is 5 bytes too high for first or only fragment, because the 9 byte I2NP header is included in that fragment.
(package private) int
fragmentSize()
How much payload data can we shove in there? This is 5 bytes too low for first or only fragment, because the 9 byte I2NP header is included in that fragment.
void
fragmentsSent(long pktNum, int length, List<PacketBuilder2.Fragment> fragments)
Record the mapping of packet number to what fragments were in it, so we can process acks.
SSU2Bitfield
getAckedMessages()
Bitfield of messages acknowledged to the peer.
(package private) int
getDestroyReason()
The destroy reason, for PeerStateDestroyed only, after we are dead.
byte
getFlags()
Flag byte to be sent in header.
long
getNextPacketNumber()
Next outbound packet number, starts at 1 for Alice (0 is Session Confirmed) and 0 for Bob.
protected long
getNextPacketNumberNoThrow()
For PeerStateDestroyed only, after we are dead.
(package private) byte[]
getOurIP()
As received in the Address Block in the handshake, or subsequently in the data phase.
(package private) int
getOurPort()
As received in the Address Block in the handshake, or subsequently in the data phase.
(package private) CipherState
getRcvCipher()
The inbound cipher state, paired with the peer's first header key.
(package private) long
getRcvConnID()
The connection ID we expect to receive packets with.
(package private) byte[]
getRcvHeaderEncryptKey1()
The first header encryption key for received packets.
(package private) byte[]
getRcvHeaderEncryptKey2()
The second header encryption key for received packets.
SSU2Bitfield
getReceivedMessages()
Bitfield of messages received from the peer.
private UDPPacket[]
getRetransmitSessionConfirmedPackets()
The saved SessionConfirmed packets for retransmission.
CipherState
getSendCipher()
Caller must sync on returned object when encrypting.
long
getSendConnID()
The send connection ID.
byte[]
getSendHeaderEncryptKey1()
The send header encryption key 1.
byte[]
getSendHeaderEncryptKey2()
The send header encryption key 2.
static long
getSentMessagesCleanTime()
Current sent-messages cleanup interval.
int
getVersion()
The version.
void
gotACK(long ackThru, int acks, byte[] ranges)
Process a received ACK block.
void
gotAddress(byte[] ip, int port)
Process a received Address block, updating our external address.
void
gotDateTime(long time)
Process a received DateTime block.
void
gotFragment(byte[] data, int off, int len, long messageId, int frag, boolean isLast)
Process a received Fragment block.
void
gotI2NP(I2NPMessage msg)
Process a received I2NP block.
void
gotOptions(byte[] options, boolean isHandshake)
Process a received Options block.
void
gotPathChallenge(RemoteHostId from, byte[] data)
Process a received PathChallenge block, replying with a PathResponse.
void
gotPathResponse(RemoteHostId from, byte[] data)
Process a received PathResponse block.
void
gotPeerTest(int msg, int status, Hash h, byte[] data)
Process a received PeerTest block.
void
gotRelayIntro(Hash aliceHash, byte[] data)
Process a received RelayIntro block.
void
gotRelayRequest(byte[] data)
Process a received RelayRequest block.
void
gotRelayResponse(int status, byte[] data)
Process a received RelayResponse block.
void
gotRelayTag(long tag)
Process a received RelayTag block.
void
gotRelayTagRequest()
Process a received RelayTagRequest block, offering a relay tag if possible.
void
gotRI(RouterInfo ri, boolean isHandshake, boolean flood)
Process a received RouterInfo block, storing and possibly flooding it.
void
gotRIFragment(byte[] data, boolean isHandshake, boolean flood, boolean isGzipped, int frag, int totalFrags)
Process a received RouterInfo fragment block.
void
gotTermination(int reason, long count)
Process a received Termination block.
void
gotToken(long token, long expires)
Process a received Token block.
private boolean
handleMigrationNone(RemoteHostId from, long n, UDPPacket packet)
Connection migration attempt while in MIGRATION_STATE_NONE.
private boolean
handleMigrationPending(RemoteHostId from, UDPPacket packet)
Connection migration attempt while in MIGRATION_STATE_PENDING.
(package private) boolean
isDead()
Whether a SessionDestroy has been sent or received on this session, so the transport can drop the session without a second teardown exchange.
protected void
messagePartiallyReceived(long now)
Overridden to use our version of ACKTimer.
private void
receiveMessage(InboundMessageState state)
Do what MessageReceiver does, but inline and for SSU2.
(package private) void
receivePacket(RemoteHostId from, UDPPacket packet)
From different than expected source IP/port.
(package private) void
receivePacket(UDPPacket packet)
Receives and decrypts the given packet.
(package private) void
sendAck0()
Send immediate ACK 0 of Session Confirmed.
private void
sendPathChallenge(InetAddress toIP, int toPort)
Caller must synch on _migrationState.
int
sentMessagesSize()
Number of pending sent-but-unacked packet entries.
void
setDestroyReason(int reason)
Record why the peer was destroyed, for the Destroy message.
(package private) void
setOurAddress(byte[] ip, int port)
For initialization by IES2/OES2 only.
static void
setSentMessagesCleanTime(long ms)
Sent-messages cleanup interval, called by Tuner.
(package private) static boolean
shouldInitiateMigration(boolean ipFamilyMatch, boolean isHighestSet, boolean validPort, boolean validIP)
Decide whether a packet from a new source address may initiate a connection migration while the connection is in MIGRATION_STATE_NONE.
private boolean
shouldLogDebug()
Whether debug logging is on for this peer.
Methods inherited from class PeerState
acked, add, adjustClockSkew, cappedRefund, changePort, classifyOutcome, congestionCooldownElapsed, dataReceived, effectiveRTO, evictInboundMessage, expireInboundMessages, fastRtxMode, getAckFrequency, getAggregateStats, getClockSkew, getClockSkewFudge, getConcurrentSends, getConcurrentSendWindow, getConsecutiveFailedSends, getConsecutiveSendRejections, getInactivityTime, getInboundMessages, getInitConcurrentMsgs, getInitRTO, getIntroducerTime, getKeyEstablishedTime, getLastACKSend, getLastReceiveTime, getLastSendFullyTime, getLastSendOrPingTime, getLastSendTime, getMaxConcurrentMessages, getMaxRTO, getMaxSendWindow, getMaxSendWindowCeiling, getMayDisconnect, getMessagesReceived, getMessagesSent, getMinConcurrentMsgs, getMinRTO, getMTU, getNextDelay, getOutboundMessageCount, getOutboundMsgExpiration, getOutboundQueueSize, getPacketsReceived, getPacketsReceivedDuplicate, getPacketsRetransmitted, getPacketsTransmitted, getPostRTOWindowMTUs, getReceiveBps, getReceiveMTU, getRemoteHostId, getRemoteIP, getRemoteIPAddress, getRemotePeer, getRemotePort, getRTO, getRTT, getRTTDeviation, getSendBps, getSendWindowBytes, getSendWindowBytesRemaining, getSlowStartThreshold, getTheyRelayToUsAs, getTransport, getWeRelayToThemAs, hasOutbound, highestSeqNumAcked, incrementConsecutiveFailedSends, isBacklogged, isInbound, isIPv6, isTotalFail, loadConfig, loadFrom, messageFullyReceived, messagePartiallyReceived, messageRetransmitted, mtuDecreaseEligible, mtuIncreaseEligible, newlyAckedBytes, nextConcurrentLimit, nextCongestionRTO, packetReceived, packetsTransmitted, pathUnverified, pathUnverifiedBlocksGrowth, pathVerified, reachedRetransmitCap, retransmitFireTime, setAckFrequency, setHisMTU, setInitConcurrentMsgs, setInitRTO, setIntroducerTime, setLastPingTime, setLastReceiveTime, setLastSendTime, setMaxConcurrentMessages, setMaxRTO, setMaxSendWindow, setMayDisconnect, setMinConcurrentMsgs, setMinRTO, setOutboundMsgExpiration, setOutboundQueueSize, setPostRTOWindowMTUs, setTheyRelayToUsAs, setWeRelayToThemAs, shouldGrowSendWindow, shouldRequestImmediateAck, shouldSkipFastRetransmit, toShortString, toString, wantLargerMTU
Modifier and Type
Method
Description
protected boolean
acked(PacketBuilder2.Fragment f)
An ACK of a fragment was received.
(package private) void
add(OutboundMessageState state)
Add an outbound message state to the queue.
(package private) void
adjustClockSkew(long skew)
Update the moving-average clock skew based on the current difference.
(package private) static int
cappedRefund(int remaining, int refund, int windowBytes)
Refund refund bytes into the send-window remaining budget, capped at the window size (never let the remaining budget exceed the congestion window, per RFC 5681).
(package private) void
changePort(int newPort)
Change the remote port.
(package private) static PeerState.Outcome
classifyOutcome(boolean complete, boolean expired, boolean overSent)
Per-message outcome in a finishAndAllocate() scan, computed once per message so the scan loop stays a thin dispatcher.
(package private) static boolean
congestionCooldownElapsed(long last, long now, int rto)
Whether enough time has elapsed since the last congestion response to allow another one.
(package private) void
dataReceived()
Same as setLastReceivedTime(now).
static int
effectiveRTO(int rto, int minRto, int maxRto)
Clamp a raw RTO estimate into the active [minRto, maxRto] window.
(package private) static InboundMessageState
evictInboundMessage(ConcurrentMap<Long, InboundMessageState> inbound)
Make room for one more partially-received inbound message.
(package private) int
expireInboundMessages()
Expire partially received inbound messages, returning how many are still pending.
(package private) static PeerState.FastRtxMode
fastRtxMode(int nacks)
Fast-retransmit progression as a function of the NACK count for a single message.
static int
getAckFrequency()
Current ACK frequency.
static long[]
getAggregateStats(Collection<PeerState> peers)
Compute aggregate transport stats across all peers for tuner visibility.
long
getClockSkew()
Clock skew.
static int
getClockSkewFudge()
Clock skew fudge factor.
int
getConcurrentSends()
Concurrent sends count.
int
getConcurrentSendWindow()
Concurrent send window.
int
getConsecutiveFailedSends()
Consecutive failed sends count.
int
getConsecutiveSendRejections()
Consecutive send rejections count.
long
getInactivityTime()
Time since the peer was last heard from or sent to fully.
(package private) Map<Long, InboundMessageState>
getInboundMessages()
Fetch the internal id (Long) to InboundMessageState for incomplete inbound messages.
static int
getInitConcurrentMsgs()
Concurrent messages a new peer starts with.
static int
getInitRTO()
Initial RTO for new peers.
(package private) long
getIntroducerTime()
Last introducer time.
long
getKeyEstablishedTime()
When the cipher and MAC keys were established.
long
getLastACKSend()
When we last sent an ACK.
long
getLastReceiveTime()
Last receive time.
long
getLastSendFullyTime()
Last send fully time.
(package private) long
getLastSendOrPingTime()
Latest of last sent, last ACK, last ping.
long
getLastSendTime()
Last send time.
static int
getMaxConcurrentMessages()
Max concurrent messages per peer.
static int
getMaxRTO()
Maximum RTO ceiling.
static int
getMaxSendWindow()
Max send window (CWIN).
static int
getMaxSendWindowCeiling()
The heap-scaled CWIN ceiling, for use by the Tuner's MaxSendWindowParam (max range must match the clamp applied in PeerState.setMaxSendWindow(int)).
boolean
getMayDisconnect()
Whether we may disconnect.
int
getMessagesReceived()
I2NP messages received.
int
getMessagesSent()
I2NP messages sent - does not include duplicates.
static int
getMinConcurrentMsgs()
Concurrent messages a degraded peer is limited to.
static int
getMinRTO()
Minimum RTO floor.
int
getMTU()
Maximum transmission unit.
(package private) int
getNextDelay(long now)
Uses cached oldest lifetime from the most recent finishAndAllocate() pass.
int
getOutboundMessageCount()
Outbound message count.
static long
getOutboundMsgExpiration()
Bridge to OutboundMessageState.getMessageExpiration for Tuner (different package).
static int
getOutboundQueueSize(RouterContext ctx, int def)
Outbound message queue depth per peer.
int
getPacketsReceived()
Packets received count.
int
getPacketsReceivedDuplicate()
Packets received duplicate count.
int
getPacketsRetransmitted()
Packets retransmitted count.
int
getPacketsTransmitted()
Packets transmitted count.
static int
getPostRTOWindowMTUs()
Post-RTO-collapse window restart size.
int
getReceiveBps(long now)
Receive Bps estimate.
int
getReceiveMTU()
Receive MTU estimate.
RemoteHostId
getRemoteHostId()
Remote host ID.
byte[]
getRemoteIP()
Remote IP address bytes.
InetAddress
getRemoteIPAddress()
Cached remote IP address.
Hash
getRemotePeer()
Remote peer hash.
int
getRemotePort()
Remote port.
int
getRTO()
Retransmission timeout.
int
getRTT()
Round trip time.
int
getRTTDeviation()
RTT deviation.
int
getSendBps(long now)
The Westwood+ bandwidth estimate.
int
getSendWindowBytes()
Send window bytes.
int
getSendWindowBytesRemaining()
Send window bytes remaining.
int
getSlowStartThreshold()
Slow start threshold.
long
getTheyRelayToUsAs()
Tag they relay to us as.
(package private) UDPTransport
getTransport()
Convenience for OutboundMessageState so it can fail itself.
long
getWeRelayToThemAs()
Tag we relay to them as.
(package private) boolean
hasOutbound()
After a finishAndAllocate() pass, reports whether any outbound messages remain.
(package private) boolean
highestSeqNumAcked(long highest)
Enter or leave fast retransmit mode, and adjust SST and window variables accordingly.
(package private) int
incrementConsecutiveFailedSends()
Increment consecutive failed sends.
boolean
isBacklogged()
Whether the peer is dead or its outbound queue is backlogged.
boolean
isInbound()
Whether this is an inbound connection.
boolean
isIPv6()
Whether the connection uses IPv6.
(package private) static boolean
isTotalFail(OutNetMessage msg, boolean isInbound, long seqNum)
Whether a failed outbound message counts as a total-first-message failure.
static void
loadConfig(RouterContext ctx)
Load configurable UDP transport parameters from router.config.
(package private) void
loadFrom(PeerState oldPeer)
Transfer the basic activity/state from the old peer to the current peer
(package private) void
messageFullyReceived(Long messageId, int bytes)
We received the message specified completely.
(package private) void
messagePartiallyReceived()
We received a partial message, or we want to send some acks.
(package private) void
messageRetransmitted(int packets, int maxPktSz)
Handle a message retransmission.
(package private) static boolean
mtuDecreaseEligible(int mtu, int minMTU, int maxPktSz)
Whether the MTU should be reduced after a lossy transmission.
(package private) static boolean
mtuIncreaseEligible(int mtu, int largeMTU, int maxPktSz, int mtuDecreases, int randomInt)
Whether a larger MTU is eligible after a clean transmission.
(package private) static int
newlyAckedBytes(int unackedBefore, boolean complete, int unackedAfter)
Compute the bytes newly confirmed by one incoming ACK for a single message: the full previously-unacked size when the message just became complete, otherwise only the delta newly covered by this ACK.
(package private) static int
nextConcurrentLimit(int numSends, int rtt, int current, int queued, int randomInt)
Compute the next concurrent-messages limit after an ACK, pure so the AIMD tuning policy is unit-testable.
(package private) static int
nextCongestionRTO(int currentRTO, int rtt, int rttDeviation, int minRTO, int maxRTO)
Compute the RTO to apply after a congestion signal.
(package private) void
packetReceived(int size)
Record a received packet.
(package private) void
packetsTransmitted(int packets)
Record that packets were transmitted.
(package private) void
pathUnverified()
Hold send-window growth while the path is unverified (SSU2 connection migration, limitSending).
(package private) static boolean
pathUnverifiedBlocksGrowth(long now, long pathUnverifiedUntil)
Whether send-window growth must be held because the path is unverified (SSU2 connection migration).
(package private) void
pathVerified()
Clear the path-unverified growth freeze (migration completed, failed, or cancelled — the current path is again the verified one).
(package private) static boolean
reachedRetransmitCap(int rvSize, int sizeBefore, boolean fastRetransmit)
Whether a retransmit-mode scan has accumulated enough messages to stop.
(package private) static long
retransmitFireTime(boolean firstArming, boolean fastRetransmit, long now, long rto)
Decide the next retransmit-timer fire time after a volley.
static void
setAckFrequency(int freq)
ACK frequency.
(package private) void
setHisMTU(int mtu)
Remote peer's MTU.
static void
setInitConcurrentMsgs(int msgs)
Initial concurrent messages per peer (called by Tuner).
static void
setInitRTO(int ms)
Initial RTO for new peers (called by Tuner).
(package private) void
setIntroducerTime()
Record the last time we used them as an introducer.
(package private) void
setLastPingTime(long when)
Last ping time.
(package private) void
setLastReceiveTime(long when)
Last receive time.
(package private) void
setLastSendTime(long when)
Last send time.
static void
setMaxConcurrentMessages(int max)
Max concurrent messages per peer (called by Tuner).
static void
setMaxRTO(int ms)
Maximum RTO ceiling (called by Tuner).
static void
setMaxSendWindow(int bytes)
Max send window / CWIN (called by Tuner).
void
setMayDisconnect()
May disconnect to true.
static void
setMinConcurrentMsgs(int msgs)
Minimum concurrent messages per peer (called by Tuner).
static void
setMinRTO(int ms)
Minimum RTO floor (called by Tuner).
static void
setOutboundMsgExpiration(long ms)
Bridge to OutboundMessageState.setMessageExpiration for Tuner (different package).
static void
setOutboundQueueSize(int size)
Outbound message queue depth per peer (called by Tuner).
static void
setPostRTOWindowMTUs(int mtus)
Send-window restart size after an RTO-timeout collapse (called by Tuner).
(package private) void
setTheyRelayToUsAs(long tag)
If they have offered to serve as an introducer to us, this is the tag we can use to publish that fact.
(package private) void
setWeRelayToThemAs(long tag)
If we are serving as an introducer to them, this is the the tag that they can publish that, when presented to us, will cause us to send a relay introduction to the current peer.
(package private) static boolean
shouldGrowSendWindow(int sendWindow, int slowStartThreshold, int bytesACKed, float randomFloat)
Whether an ACK should grow the send window.
protected boolean
shouldRequestImmediateAck()
SSU 2 only.
(package private) static boolean
shouldSkipFastRetransmit(boolean fastRetransmit, int nacks)
Whether to skip a message during a retransmit-mode scan.
(package private) String
toShortString()
Compact one-line peer identifier for log output: short hash, direction, version and remote host id.
String
toString()

(package private) static boolean
wantLargerMTU(boolean success, int packetsTransmitted, int packetsRetransmitted)
Whether a near-lossless transmission history warrants probing a larger MTU.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface SSU2Sender
getMTU, getRemoteHostId, getRemoteIPAddress, getRemotePort, isIPv6
Modifier and Type
Method
Description
int
getMTU()
Maximum transmission unit.
RemoteHostId
getRemoteHostId()
Remote host ID.
InetAddress
getRemoteIPAddress()
Remote IP address.
int
getRemotePort()
Remote port.
boolean
isIPv6()
Whether the remote is IPv6.

Field Details
- _sendConnID
  private final long _sendConnID
  Connection id we send with.
- _rcvConnID
  private final long _rcvConnID
  Connection id we receive with.
- _packetNumber
  private final AtomicLong _packetNumber
  Next SSU2 packet number to send.
- MAX_PACKET_NUMBER
  private static final long MAX_PACKET_NUMBER
  Last usable outbound packet number, see getNextPacketNumber(). @since 0.9.71+
  See Also:
  Constant Field Values
- _lastAckHashCode
  private final AtomicInteger _lastAckHashCode
  Hash of the last ack sent, to skip duplicates.
- _sendCha
  private final CipherState _sendCha
  ChaCha20 state for encrypting sent packets.
- _rcvCha
  private final CipherState _rcvCha
  ChaCha20 state for decrypting received packets.
- _sendHeaderEncryptKey1
  private final byte[] _sendHeaderEncryptKey1
  First header encryption key for sending.
- _rcvHeaderEncryptKey1
  private final byte[] _rcvHeaderEncryptKey1
  First header encryption key for receiving.
- _sendHeaderEncryptKey2
  private final byte[] _sendHeaderEncryptKey2
  Second header encryption key for sending.
- _rcvHeaderEncryptKey2
  private final byte[] _rcvHeaderEncryptKey2
  Second header encryption key for receiving.
- _receivedMessages
  private final SSU2Bitfield _receivedMessages
  Bitfield of received message numbers.
- _ackedMessages
  private final SSU2Bitfield _ackedMessages
  PS1 has _ackedMessages which is a map of message ID to sequence number. Here we have the reverse, a bitfield of acked packet (sequence) numbers, and map of unacked packet (sequence) numbers to the fragments that packet contained.
- _sentMessages
  private final ConcurrentHashMap<Long, List<PacketBuilder2.Fragment>> _sentMessages
  Sent messages awaiting acks, by message id.
- _ackTimer
  private final PeerState2.ACKTimer _ackTimer
  Timer scheduling acks and retransmits.
- _sentMessagesLastExpired
  private long _sentMessagesLastExpired
  When sent messages were last expired.
- _sentMessagesExpiryCursor
  private final ArrayDeque<Map.Entry<Long, List<PacketBuilder2.Fragment>>> _sentMessagesExpiryCursor
  Incremental expiry cursor over a snapshot of _sentMessages, so a tick examines a bounded number of entries instead of the whole map. Only touched from the PacketPusher thread via finishAndAllocate().
- _ourIP
  private volatile byte[] _ourIP
  Our IP as the peer sees it.
- _ourPort
  private volatile int _ourPort
  Our port as the peer sees it.
- _destroyReason
  private volatile int _destroyReason
  Reason code for destroying this state.
- _sessConfForReTX
  private byte[][] _sessConfForReTX
  Session Confirmed packets held for retransmission.
- _sessConfSentTime
  private long _sessConfSentTime
  When a Session Confirmed was last sent.
- _sessConfSentCount
  private int _sessConfSentCount
  Session Confirmed retransmit attempts so far.
- _migrationLock
  private final Object _migrationLock
  Lock for the connection migration state.
- _migrationState
  private PeerState2.MigrationState _migrationState
  Current connection migration state.
- _migrationStarted
  private long _migrationStarted
  When the current migration started.
- _migrationNextSendTime
  private long _migrationNextSendTime
  When the next migration path challenge is due.
- _pathChallengeData
  private byte[] _pathChallengeData
  Data of the path challenge we sent.
- _pathChallengeSendCount
  private long _pathChallengeSendCount
  Path challenges sent for the current migration.
- _pendingRemoteHostId
  private RemoteHostId _pendingRemoteHostId
  New host id pending confirmation during migration.
- MAX_PATH_CHALLENGE_SENDS
  static final int MAX_PATH_CHALLENGE_SENDS
  Path challenge retransmissions before the migration is declared expired.
  See Also:
  Constant Field Values
- MAX_PATH_CHALLENGE_TIME
  static final long MAX_PATH_CHALLENGE_TIME
  Total time a path challenge may span, in ms, before it is declared expired.
  See Also:
  Constant Field Values
- PATH_CHALLENGE_DELAY
  static final long PATH_CHALLENGE_DELAY
  Base interval between path challenge sends in ms, doubled per retransmission.
  See Also:
  Constant Field Values
- MIN_SSU_IPV4_MTU
  public static final int MIN_SSU_IPV4_MTU
  MIN_SSU_IPV4_MTU.
  See Also:
  Constant Field Values
- MAX_SSU_IPV4_MTU
  public static final int MAX_SSU_IPV4_MTU
  MAX_SSU_IPV4_MTU.
  See Also:
  Constant Field Values
- DEFAULT_SSU_IPV4_MTU
  public static final int DEFAULT_SSU_IPV4_MTU
  DEFAULT_SSU_IPV4_MTU.
  See Also:
  Constant Field Values
- MIN_SSU_IPV6_MTU
  public static final int MIN_SSU_IPV6_MTU
  MIN_SSU_IPV6_MTU.
  See Also:
  Constant Field Values
- MAX_SSU_IPV6_MTU
  public static final int MAX_SSU_IPV6_MTU
  MAX_SSU_IPV6_MTU.
  See Also:
  Constant Field Values
- DEFAULT_SSU_IPV6_MTU
  public static final int DEFAULT_SSU_IPV6_MTU
  DEFAULT_SSU_IPV6_MTU.
  See Also:
  Constant Field Values
- MIN_MTU
  public static final int MIN_MTU
  Smallest MTU we will advertise to SSU2 peers, in bytes.
  See Also:
  Constant Field Values
- MAX_MTU
  public static final int MAX_MTU
  Largest MTU we will advertise to SSU2 peers, in bytes.
  See Also:
  Constant Field Values
- DEFAULT_MTU
  public static final int DEFAULT_MTU
  MTU advertised unless the profile overrides it.
  See Also:
  Constant Field Values
- MIN_MLKEM768_IPV4_MTU
  public static final int MIN_MLKEM768_IPV4_MTU
  MIN_MLKEM768_IPV4_MTU.
  See Also:
  Constant Field Values
- MIN_MLKEM768_IPV6_MTU
  public static final int MIN_MLKEM768_IPV6_MTU
  MIN_MLKEM768_IPV6_MTU.
  See Also:
  Constant Field Values
- BITFIELD_SIZE
  private static final int BITFIELD_SIZE
  Message numbers tracked in the received bitfield.
  See Also:
  Constant Field Values
- MAX_SESS_CONF_RETX
  private static final int MAX_SESS_CONF_RETX
  Session Confirmed retransmits before giving up.
  See Also:
  Constant Field Values
- _sentMessagesCleanTime
  private static volatile long _sentMessagesCleanTime
  Configurable sent-messages sweep interval. Default 60s, shortened under load.
- SENT_MESSAGES_EXPIRE_BATCH
  private static final int SENT_MESSAGES_EXPIRE_BATCH
  Max _sentMessages entries examined per expireSentMessages(long) call. @since 0.9.71+.
  See Also:
  Constant Field Values
Constructor Details
- PeerState2
  public PeerState2(RouterContext ctx, UDPTransport transport, InetSocketAddress remoteAddress, Hash remotePeer, boolean isInbound, int rtt, CipherState sendCha, CipherState rcvCha, long sendID, long rcvID, byte[] sendHdrKey1, byte[] sendHdrKey2, byte[] rcvHdrKey2)
  A session with a remote peer over SSU2: the connection ids, the four cipher states and the header encryption keys are all fixed here, so the transport can build one without a separate handshake step.
  If inbound, caller MUST immediately call setWeRelayToThemAs() (if nonzero) and sendAck0().
  Parameters:
  ctx - the router context
  transport - the UDP transport this session runs on
  remoteAddress - the peer's address, which may change on migration
  remotePeer - the peer's router hash
  isInbound - true if the peer opened the session, false if we did
  rtt - from the EstablishState, or 0 if not available
  sendCha - the outbound cipher state for payload blocks
  rcvCha - the inbound cipher state for payload blocks
  sendID - the connection id we send in every block header
  rcvID - the connection id the peer sends in every block header
  sendHdrKey1 - the first outbound header encryption key
  sendHdrKey2 - the second outbound header encryption key
  rcvHdrKey2 - the second inbound header encryption key
Method Details
- shouldLogDebug
  private boolean shouldLogDebug()
  Whether debug logging is on for this peer.
  Returns:
  true if debug logging is enabled
- getSentMessagesCleanTime
  public static long getSentMessagesCleanTime()
  Current sent-messages cleanup interval.
  Returns:
  current sent-messages cleanup interval in ms
- setSentMessagesCleanTime
  public static void setSentMessagesCleanTime(long ms)
  Sent-messages cleanup interval, called by Tuner.
  Parameters:
  ms - cleanup interval in ms, clamped to [2000, 300000]
- sendAck0
  void sendAck0()
  Send immediate ACK 0 of Session Confirmed. Inbound only. Bundle relay tag if requested, see InboundEstablishState2.
- getVersion
  public int getVersion()
  The version.
  Overrides:
  getVersion in class PeerState
  Returns:
  2, as this class implements SSU2
- fragmentSize
  int fragmentSize()
  How much payload data can we shove in there? This is 5 bytes too low for first or only fragment, because the 9 byte I2NP header is included in that fragment. Does NOT leave any room for acks with a full-size fragment.
  Overrides:
  fragmentSize in class PeerState
  Returns:
  MTU - 68 (IPv4), MTU - 88 (IPv6)
- fragmentOverhead
  int fragmentOverhead()
  Packet overhead This is 5 bytes too high for first or only fragment, because the 9 byte I2NP header is included in that fragment. Does NOT leave any room for acks with a full-size fragment.
  Overrides:
  fragmentOverhead in class PeerState
  Returns:
  68 (IPv4), 88 (IPv6)
- clearWantedACKSendSince
  void clearWantedACKSendSince()
  All acks have been sent.
  Overrides:
  clearWantedACKSendSince in class PeerState
- messagePartiallyReceived
  protected void messagePartiallyReceived(long now)
  Overridden to use our version of ACKTimer.
  Overrides:
  messagePartiallyReceived in class PeerState
  Parameters:
  now - the current time
- expireSentMessages
  private void expireSentMessages(long now)
  Expire complete or timed-out entries from _sentMessages, walking an incremental cursor instead of rescanning the whole map and every fragment list on every tick.
  The cursor holds a snapshot of the map taken when it runs dry; entries acked in the meantime are skipped by the identity check, and newly added entries are picked up on the next refill. An entry is removed only when every fragment's message is complete or expired, so it never expires early. One pass covers the whole cursor, so retention matches the old full scan's single tick.
  Only called from finishAndAllocate(long) on the PacketPusher thread, so the cursor needs no synchronization. Failure detection is unaffected: that is the "ahead > BITFIELD_SIZE" check in finishAndAllocate(long), which runs on its own schedule.
  Parameters:
  now - current time, for the expiry test
- finishAndAllocate
  List<OutboundMessageState> finishAndAllocate(long now)
  Single-pass combined cleanup + send allocation, overriding the base class to incorporate SSU2-specific _sentMessages cleanup and SessionConfirmed retransmit logic.
  Overrides:
  finishAndAllocate in class PeerState
  Parameters:
  now - current time in ms, used as the expiry base for the messages that are allocated here
  Returns:
  messages to send, or null if none ready
- checkRetransmitSessionConfirmed
  private boolean checkRetransmitSessionConfirmed(long now, boolean force)
  Only call for outbound, if we don't have ack 0 yet.
  Parameters:
  now - the current time in ms for the retransmit timer
  force - ignore timer, always send
  Returns:
  success, false if total fail
- checkRetransmitSessionConfirmed2
  private boolean checkRetransmitSessionConfirmed2(long now, boolean force)
  Only call for outbound, if we don't have ack 0 yet.
  Parameters:
  now - the current time in ms for the retransmit timer
  force - ignore timer, always send
  Returns:
  success, false if total fail
- getNextPacketNumber
  public long getNextPacketNumber() throws IOException
  Next outbound packet number, starts at 1 for Alice (0 is Session Confirmed) and 0 for Bob. The packet number is a 4-byte header field and doubles as the ChaCha20 and Poly1305 nonce, so the session must not outlive the number space - wrapping would silently reuse keystream and the Poly1305 key. A busy router can burn 2^32 numbers in hours, hence the guard. Leaves 256 numbers of headroom for the destroy packets sent after death.
  Specified by:
  getNextPacketNumber in interface SSU2Sender
  Returns:
  the next packet number
  Throws:
  IOException - if the number space is exhausted, killing the session so the caller re-handshakes with fresh keys
- getNextPacketNumberNoThrow
  protected long getNextPacketNumberNoThrow()
  For PeerStateDestroyed only, after we are dead.
  Returns:
  the next packet number no throw
- getSendConnID
  public long getSendConnID()
  The send connection ID. For PeerStateDestroyed only, after we are dead.
  Specified by:
  getSendConnID in interface SSU2Sender
  Returns:
  the send conn i d
- getSendCipher
  public CipherState getSendCipher()
  Caller must sync on returned object when encrypting.
  Specified by:
  getSendCipher in interface SSU2Sender
  Returns:
  the send cipher
- getSendHeaderEncryptKey1
  public byte[] getSendHeaderEncryptKey1()
  The send header encryption key 1. Caller must sync on returned object when encrypting.
  Specified by:
  getSendHeaderEncryptKey1 in interface SSU2Sender
  Returns:
  the send header encrypt key1
- getSendHeaderEncryptKey2
  public byte[] getSendHeaderEncryptKey2()
  The send header encryption key 2. Caller must sync on returned object when encrypting.
  Specified by:
  getSendHeaderEncryptKey2 in interface SSU2Sender
  Returns:
  the send header encrypt key2
- setDestroyReason
  public void setDestroyReason(int reason)
  Record why the peer was destroyed, for the Destroy message.
  Specified by:
  setDestroyReason in interface SSU2Sender
  Parameters:
  reason - the SSU2Util termination code, echoed to the peer in a SessionDestroy and ignored once destroyed
- getRcvConnID
  long getRcvConnID()
  The connection ID we expect to receive packets with.
  Returns:
  the receive connection ID
- getRcvHeaderEncryptKey1
  byte[] getRcvHeaderEncryptKey1()
  The first header encryption key for received packets.
  Returns:
  the receive header key 1
- getRcvHeaderEncryptKey2
  byte[] getRcvHeaderEncryptKey2()
  The second header encryption key for received packets.
  Returns:
  the receive header key 2
- getDestroyReason
  int getDestroyReason()
  The destroy reason, for PeerStateDestroyed only, after we are dead.
  Returns:
  0 (REASON_UNSPEC) if unset
- getRcvCipher
  CipherState getRcvCipher()
  The inbound cipher state, paired with the peer's first header key.
  Returns:
  the inbound payload cipher state
- setOurAddress
  void setOurAddress(byte[] ip, int port)
  For initialization by IES2/OES2 only.
  Parameters:
  ip - our address as the peer will see it, 4 or 16 bytes
  port - our port as the peer will see it
- getOurIP
  byte[] getOurIP()
  As received in the Address Block in the handshake, or subsequently in the data phase. Unvalidated. Also, if a transient IPv6 address, may be deprecated and not match our current non-deprecated IPv6 address.
  Returns:
  our address as the peer sees it, 4 or 16 bytes, or null if unset
- getOurPort
  int getOurPort()
  As received in the Address Block in the handshake, or subsequently in the data phase. Unvalidated.
  Returns:
  our port as the peer sees it, or 0 if unset
- getReceivedMessages
  public SSU2Bitfield getReceivedMessages()
  Bitfield of messages received from the peer.
  Specified by:
  getReceivedMessages in interface SSU2Sender
  Returns:
  the received messages
- getAckedMessages
  public SSU2Bitfield getAckedMessages()
  Bitfield of messages acknowledged to the peer.
  Specified by:
  getAckedMessages in interface SSU2Sender
  Returns:
  the acked messages
- receivePacket
  void receivePacket(UDPPacket packet)
  Receives and decrypts the given packet.
  Parameters:
  packet - fully encrypted, header and body decryption will be done here
- receivePacket
  void receivePacket(RemoteHostId from, UDPPacket packet)
  From different than expected source IP/port.
  Parameters:
  from - source address the packet did not come from; a mismatch causes the packet to be dropped
  packet - fully encrypted, header and body decryption will be done here
- handleMigrationNone
  private boolean handleMigrationNone(RemoteHostId from, long n, UDPPacket packet)
  Connection migration attempt while in MIGRATION_STATE_NONE.
  A packet from a host different from the current remote host starts a migration only when it passes the pure shouldInitiateMigration(boolean, boolean, boolean, boolean) classifier (IP family match, highest-set ordering rule, validated source). Path Response processing happens earlier in receivePacket, so a completed migration has already reset the state before this runs. Sending is limited only while a challenge is actually outstanding; a refused migration must not freeze the verified path.
  Must be called with _migrationLock held.
  Parameters:
  from - source address of the received packet, or null
  n - packet (sequence) number of the received packet
  packet - the received packet (source address used for the challenge)
  Returns:
  true if sending must be limited while the connection is migrating
- handleMigrationPending
  private boolean handleMigrationPending(RemoteHostId from, UDPPacket packet)
  Connection migration attempt while in MIGRATION_STATE_PENDING.
  The packet source is classified by the pure decidePendingMigration(long, boolean, boolean, long, long, long) method. This method applies the side effects (cancel/timeout state reset, path-challenge retransmission with exponential backoff).
  Must be called with _migrationLock held.
  Parameters:
  from - source address of the received packet, or null
  packet - the received packet (source address used for retransmission)
  Returns:
  true if sending must be limited while the connection is migrating
- shouldInitiateMigration
  static boolean shouldInitiateMigration(boolean ipFamilyMatch, boolean isHighestSet, boolean validPort, boolean validIP)
  Decide whether a packet from a new source address may initiate a connection migration while the connection is in MIGRATION_STATE_NONE.
  The source IP family must match the current remote host, the packet must be the highest sequence received so far (QUIC ordering rule, protects against reordered packets driving a migration to an attacker-chosen address), and the source must pass both port and address validation.
  Parameters:
  ipFamilyMatch - true if the source IP family matches the current remote host
  isHighestSet - true if the packet is the highest sequence received so far
  validPort - true if the source port is valid
  validIP - true if the source IP passes transport address validation
  Returns:
  a boolean indicating whether to start the migration challenge
- decidePendingMigration
  static PeerState2.MigrationPendingDecision decidePendingMigration(long now, boolean fromIsRemote, boolean fromIsPending, long migrationStarted, long sendCount, long nextSendTime)
  Classify what to do with a packet received while the connection is in MIGRATION_STATE_PENDING. Pure decision; side effects are applied by the caller. Order of precedence: the current remote host wins (cancel), the timeout/send-budget check wins over retransmission.
  Parameters:
  now - current time ms
  fromIsRemote - true if the source is the current (pre-migration) remote host
  fromIsPending - true if the source is the pending migration target
  migrationStarted - ms at which the migration was started
  sendCount - number of path challenges already sent
  nextSendTime - ms at which the next retransmission is due
  Returns:
  the pending-migration action to take
- sendPathChallenge
  private void sendPathChallenge(InetAddress toIP, int toPort)
  Caller must synch on _migrationState.
  Parameters:
  toIP - the address to send the path challenge to
  toPort - the port to send the path challenge to
- gotDateTime
  public void gotDateTime(long time)
  Process a received DateTime block.
  Specified by:
  gotDateTime in interface SSU2Payload.PayloadCallback
  Parameters:
  time - time in milliseconds since epoch
- gotOptions
  public void gotOptions(byte[] options, boolean isHandshake)
  Process a received Options block.
  Specified by:
  gotOptions in interface SSU2Payload.PayloadCallback
  Parameters:
  options - the option data
  isHandshake - true only for message 3 part 2
- gotRI
  public void gotRI(RouterInfo ri, boolean isHandshake, boolean flood) throws DataFormatException
  Process a received RouterInfo block, storing and possibly flooding it.
  Specified by:
  gotRI in interface SSU2Payload.PayloadCallback
  Parameters:
  ri - will already be validated
  isHandshake - true only for message 3 part 2
  flood - true if this is a floodfill router
  Throws:
  DataFormatException - if the RouterInfo block is malformed
- gotRIFragment
  public void gotRIFragment(byte[] data, boolean isHandshake, boolean flood, boolean isGzipped, int frag, int totalFrags)
  Process a received RouterInfo fragment block.
  Specified by:
  gotRIFragment in interface SSU2Payload.PayloadCallback
  Parameters:
  data - is first gzipped and then fragmented
  isHandshake - true only for message 3 part 2
  flood - true if this is a floodfill router
  isGzipped - true if the data is gzipped
  frag - fragment number (0-based)
  totalFrags - total number of fragments
- gotAddress
  public void gotAddress(byte[] ip, int port)
  Process a received Address block, updating our external address.
  Specified by:
  gotAddress in interface SSU2Payload.PayloadCallback
  Parameters:
  ip - IP address bytes
  port - the port number to send
- gotRelayTagRequest
  public void gotRelayTagRequest()
  Process a received RelayTagRequest block, offering a relay tag if possible.
  Specified by:
  gotRelayTagRequest in interface SSU2Payload.PayloadCallback
- gotRelayTag
  public void gotRelayTag(long tag)
  Process a received RelayTag block.
  Specified by:
  gotRelayTag in interface SSU2Payload.PayloadCallback
  Parameters:
  tag - the relay tag
- gotRelayRequest
  public void gotRelayRequest(byte[] data)
  Process a received RelayRequest block.
  Specified by:
  gotRelayRequest in interface SSU2Payload.PayloadCallback
  Parameters:
  data - excludes flag, includes signature
- gotRelayResponse
  public void gotRelayResponse(int status, byte[] data)
  Process a received RelayResponse block.
  Specified by:
  gotRelayResponse in interface SSU2Payload.PayloadCallback
  Parameters:
  status - 0 = accept, 1-255 = reject
  data - excludes flag, includes signature
- gotRelayIntro
  public void gotRelayIntro(Hash aliceHash, byte[] data)
  Process a received RelayIntro block.
  Specified by:
  gotRelayIntro in interface SSU2Payload.PayloadCallback
  Parameters:
  aliceHash - hash of the introducer
  data - excludes flag, includes signature
- gotPeerTest
  public void gotPeerTest(int msg, int status, Hash h, byte[] data)
  Process a received PeerTest block.
  Specified by:
  gotPeerTest in interface SSU2Payload.PayloadCallback
  Parameters:
  msg - 1-7
  status - 0 = accept, 1-255 = reject
  h - Alice or Charlie hash for msg 2 and 4, null for msg 1, 3, 5-7
  data - excludes flag, includes signature
- gotToken
  public void gotToken(long token, long expires)
  Process a received Token block.
  Specified by:
  gotToken in interface SSU2Payload.PayloadCallback
  Parameters:
  token - the session token to attach to the next peer test
  expires - token expiration time in milliseconds
- gotI2NP
  public void gotI2NP(I2NPMessage msg)
  Process a received I2NP block.
  Specified by:
  gotI2NP in interface SSU2Payload.PayloadCallback
  Parameters:
  msg - the parsed I2NP message
- gotFragment
  public void gotFragment(byte[] data, int off, int len, long messageId, int frag, boolean isLast) throws DataFormatException
  Process a received Fragment block.
  Specified by:
  gotFragment in interface SSU2Payload.PayloadCallback
  Parameters:
  data - buffer containing fragment data
  off - offset in data
  len - length of data to copy
  messageId - unique message identifier
  frag - fragment number (0-based)
  isLast - whether this is the last fragment
  Throws:
  DataFormatException - if the fragment is malformed
- gotACK
  public void gotACK(long ackThru, int acks, byte[] ranges)
  Process a received ACK block.
  Specified by:
  gotACK in interface SSU2Payload.PayloadCallback
  Parameters:
  ackThru - highest contiguous sequence number acknowledged
  acks - number of additional acknowledgments beyond ackThru
  ranges - null if none
- gotTermination
  public void gotTermination(int reason, long count)
  Process a received Termination block.
  Specified by:
  gotTermination in interface SSU2Payload.PayloadCallback
  Parameters:
  reason - termination reason code
  count - in theory could wrap around to negative, but very unlikely
- gotPathChallenge
  public void gotPathChallenge(RemoteHostId from, byte[] data)
  Process a received PathChallenge block, replying with a PathResponse.
  Specified by:
  gotPathChallenge in interface SSU2Payload.PayloadCallback
  Parameters:
  from - null if unknown
  data - the challenge bytes, which must be copied out
- gotPathResponse
  public void gotPathResponse(RemoteHostId from, byte[] data)
  Process a received PathResponse block.
  Specified by:
  gotPathResponse in interface SSU2Payload.PayloadCallback
  Parameters:
  from - null if unknown
  data - the response bytes, which must be copied out
- changeAddress
  void changeAddress(RemoteHostId id)
  Caller should sync; UDPTransport must remove and add to peersByRemoteHost map.
  Parameters:
  id - the new remote host id, carrying both the address and the port
- receiveMessage
  private void receiveMessage(InboundMessageState state)
  Do what MessageReceiver does, but inline and for SSU2. Will always be more than one fragment.
  Parameters:
  state - the complete multi-fragment message to reassemble and queue
- fragmentsSent
  public void fragmentsSent(long pktNum, int length, List<PacketBuilder2.Fragment> fragments)
  Record the mapping of packet number to what fragments were in it, so we can process acks.
  Specified by:
  fragmentsSent in interface SSU2Sender
  Parameters:
  pktNum - the packet number the fragments were sent under
  length - including ip/udp header, for logging only
  fragments - fragment list
- bitSet
  public void bitSet(long pktNum)
  Callback from SSU2Bitfield.forEachAndNot(SSU2Bitfield, SSU2Bitfield.Callback). A new ack was received.
  Specified by:
  bitSet in interface SSU2Bitfield.Callback
  Parameters:
  pktNum - the absolute message number that was newly set
- confirmedPacketsSent
  void confirmedPacketsSent(byte[][] data)
  Note that we just sent the SessionConfirmed packets and save them for retransmission. This is only called the first time. For retransmit see allocateSend() above.
  Parameters:
  data - the SessionConfirmed packet bodies, retained only if this is the first send so a retransmission can resend the same bytes
- getRetransmitSessionConfirmedPackets
  private UDPPacket[] getRetransmitSessionConfirmedPackets()
  The saved SessionConfirmed packets for retransmission.
  Returns:
  null if not sent or already got the ack
- getFlags
  public byte getFlags()
  Flag byte to be sent in header.
  Specified by:
  getFlags in interface SSU2Sender
  Returns:
  the header flag byte, 0x01 when the send window has under a third of its capacity left and an immediate ack is requested, otherwise 0
- isDead
  boolean isDead()
  Whether a SessionDestroy has been sent or received on this session, so the transport can drop the session without a second teardown exchange.
  Returns:
  true once the session has been destroyed
- sentMessagesSize
  public int sentMessagesSize()
  Number of pending sent-but-unacked packet entries.
  Returns:
  the number of packet entries awaiting an ACK, not a byte count
- dropOutbound
  void dropOutbound()
  Overridden to also clear sent-but-unacked fragments and cancel ACKTimer. Prevents lingering references from keeping orphaned PeerState2 alive.
  Overrides:
  dropOutbound in class PeerState

Nested Class Summary

Nested classes/interfaces inherited from class PeerState

Field Summary

Fields inherited from class PeerState

Constructor Summary

Method Summary

Methods inherited from class PeerState

Methods inherited from class Object

Methods inherited from interface SSU2Sender

Field Details

_sendConnID

_rcvConnID

_packetNumber

MAX_PACKET_NUMBER

_lastAckHashCode

_sendCha

_rcvCha

_sendHeaderEncryptKey1

_rcvHeaderEncryptKey1

_sendHeaderEncryptKey2

_rcvHeaderEncryptKey2

_receivedMessages

_ackedMessages

_sentMessages

_ackTimer

_sentMessagesLastExpired

_sentMessagesExpiryCursor

_ourIP

_ourPort

_destroyReason

_sessConfForReTX

_sessConfSentTime

_sessConfSentCount

_migrationLock

_migrationState

_migrationStarted

_migrationNextSendTime

_pathChallengeData

_pathChallengeSendCount

_pendingRemoteHostId

MAX_PATH_CHALLENGE_SENDS

MAX_PATH_CHALLENGE_TIME

PATH_CHALLENGE_DELAY

MIN_SSU_IPV4_MTU

MAX_SSU_IPV4_MTU

DEFAULT_SSU_IPV4_MTU

MIN_SSU_IPV6_MTU

MAX_SSU_IPV6_MTU

DEFAULT_SSU_IPV6_MTU

MIN_MTU

MAX_MTU

DEFAULT_MTU

MIN_MLKEM768_IPV4_MTU

MIN_MLKEM768_IPV6_MTU

BITFIELD_SIZE

MAX_SESS_CONF_RETX

_sentMessagesCleanTime

SENT_MESSAGES_EXPIRE_BATCH

Constructor Details

Method Details

shouldLogDebug

getSentMessagesCleanTime

setSentMessagesCleanTime

sendAck0

getVersion

fragmentSize

fragmentOverhead

clearWantedACKSendSince

messagePartiallyReceived

expireSentMessages

finishAndAllocate

checkRetransmitSessionConfirmed

checkRetransmitSessionConfirmed2

getNextPacketNumber

getNextPacketNumberNoThrow

getSendConnID

getSendCipher

getSendHeaderEncryptKey1

getSendHeaderEncryptKey2