OutboundGatewayMessage

java.lang.Object

net.i2p.router.tunnel.PendingGatewayMessage

net.i2p.router.tunnel.OutboundGatewayMessage

All Implemented Interfaces:: CDPQEntry, CDQEntry, PQEntry

class OutboundGatewayMessageextends PendingGatewayMessage implements CDPQEntry

Stores all the state for an unsent or partially-sent message.

Field Summary
Fields
Modifier and Type
Field
Description
private final int
_priority
Priority level the message was sent at.
private long
_seqNum
Sequence number in the tunnel's CDP window.
Fields inherited from class PendingGatewayMessage
_created, _expiration, _fragmentNumber, _messageId, _offset, _remaining, _toRouter, _toTunnel
Modifier and Type
Field
Description
protected final long
_created
When this message was created.
protected final long
_expiration
The message expiration.
protected int
_fragmentNumber
Which fragment we are working on.
protected final long
_messageId
The message ID.
protected int
_offset
Index into the data to be sent.
protected final byte[]
_remaining
Raw unfragmented message data.
protected final Hash
_toRouter
The destination router.
protected final TunnelId
_toTunnel
The destination tunnel.
Constructor Summary
Constructors
Constructor
Description
OutboundGatewayMessage(I2NPMessage message, Hash toRouter, TunnelId toTunnel)
Caches the message priority, which the fragmenter queue orders by.
Method Summary
Modifier and Type
Method
Description
int
getPriority()
For CDPQ.
private static int
getPriority(I2NPMessage message)
This is just for priority in the queue waiting for the fragmenter.
long
getSeqNum()
For CDPQ.
void
setSeqNum(long num)
For CDPQ.
Methods inherited from class PendingGatewayMessage
addMessageId, drop, getData, getEnqueueTime, getExpiration, getFragmentNumber, getLifetime, getMessageId, getMessageIds, getOffset, getToRouter, getToTunnel, incrementFragmentNumber, setEnqueueTime, setOffset, toString
Modifier and Type
Method
Description
void
addMessageId(long id)
Add an ID to the list of the TunnelDataMssages this message was fragmented into.
void
drop()
For CDQ.
byte[]
getData()
The raw unfragmented message to send.
long
getEnqueueTime()
For CDQ.
long
getExpiration()
Message expiration time.
int
getFragmentNumber()
Which fragment are we working on (0 for the first fragment).
long
getLifetime()
Lifetime in milliseconds.
long
getMessageId()
Message ID.
List<Long>
getMessageIds()
The IDs of the TunnelDataMssages this message was fragmented into.
int
getOffset()
The index into the data to be sent.
Hash
getToRouter()
The destination router.
TunnelId
getToTunnel()
The destination tunnel.
void
incrementFragmentNumber()
Fragment sent, so move on to the next one.
void
setEnqueueTime(long now)
For CDQ.
void
setOffset(int offset)
Move the offset.
String
toString()
Debug description of this pending message and its progress.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- _seqNum
  private long _seqNum
  Sequence number in the tunnel's CDP window.
- _priority
  private final int _priority
  Priority level the message was sent at.
Constructor Details
- OutboundGatewayMessage
  public OutboundGatewayMessage(I2NPMessage message, Hash toRouter, TunnelId toTunnel)
  Caches the message priority, which the fragmenter queue orders by.
  Parameters:
  message - the I2NP message to be delivered, whose priority is cached here
  toRouter - the router the message is addressed to
  toTunnel - the tunnel the message is addressed to
Method Details
- setSeqNum
  public void setSeqNum(long num)
  For CDPQ.
  Specified by:
  setSeqNum in interface PQEntry
  Parameters:
  num - the sequence number
- getSeqNum
  public long getSeqNum()
  For CDPQ.
  Specified by:
  getSeqNum in interface PQEntry
  Returns:
  the seq num
- getPriority
  public int getPriority()
  For CDPQ.
  Specified by:
  getPriority in interface PQEntry
  Returns:
  the CDPQ priority assigned at construction
- getPriority
  private static int getPriority(I2NPMessage message)
  This is just for priority in the queue waiting for the fragmenter. After the fragmenter, they will be OutNetMessages with priority 400. We use the same 100-500 priority as OutNetMessage so the stats in CoDelPriorityBlockingQueue work.
  We could - perhaps - have BatchedPreprocessor pass the max priority of any message fragment in a TunnelDataMessage to the OutboundReceiver, to set the OutNetMessage priority - but that may just make more of an out-of-order mess and failed reconstruction of fragments.
  Parameters:
  message - the message to classify, its type selects the priority
  Returns:
  the CDPQ priority for the message type, 1000 for a tagset reply down to 100 for regular data and anything unexpected

Field Summary

Fields inherited from class PendingGatewayMessage

Constructor Summary

Method Summary

Methods inherited from class PendingGatewayMessage

Methods inherited from class Object

Field Details

_seqNum

_priority

Constructor Details

Method Details

setSeqNum

getSeqNum

getPriority

getPriority