PendingGatewayMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.tunnel.PendingGatewayMessage

All Implemented Interfaces:
CDQEntry
Direct Known Subclasses:
OutboundGatewayMessage
```
class PendingGatewayMessage
extends Object
implements CDQEntry
```
Stores all the state for an unsent or partially-sent message

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`_created` when this message was created
`protected long`	`_expiration` the message expiration
`protected int`	`_fragmentNumber` which fragment are we working on
`protected long`	`_messageId` the message ID
`protected int`	`_offset` index into the data to be sent
`protected byte[]`	`_remaining` raw unfragmented message data
`protected Hash`	`_toRouter` the destination router
`protected TunnelId`	`_toTunnel` the destination tunnel

Constructor Summary
Constructors
Constructor and Description
PendingGatewayMessage(I2NPMessage message, Hash toRouter, TunnelId toTunnel)
PendingGatewayMessage.

Constructors
Constructor and Description
`PendingGatewayMessage(I2NPMessage message, Hash toRouter, TunnelId toTunnel)` PendingGatewayMessage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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()`
`int`	`getFragmentNumber()` Which fragment are we working on (0 for the first fragment).
`long`	`getLifetime()`
`long`	`getMessageId()`
`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()` ok, fragment sent, increment what the next will be
`void`	`setEnqueueTime(long now)` For CDQ
`void`	`setOffset(int offset)` Move the offset.
`String`	`toString()` toString.

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

- Field Detail
  - _created
```
protected final long _created
```
    when this message was created
  - _expiration
```
protected final long _expiration
```
    the message expiration
  - _fragmentNumber
```
protected int _fragmentNumber
```
    which fragment are we working on
  - _messageId
```
protected final long _messageId
```
    the message ID
  - _offset
```
protected volatile int _offset
```
    index into the data to be sent
  - _remaining
```
protected final byte[] _remaining
```
    raw unfragmented message data
  - _toRouter
```
protected final Hash _toRouter
```
    the destination router
  - _toTunnel
```
protected final TunnelId _toTunnel
```
    the destination tunnel
- Constructor Detail
  - PendingGatewayMessage
```
public PendingGatewayMessage(I2NPMessage message,
                             Hash toRouter,
                             TunnelId toTunnel)
```
    PendingGatewayMessage.
- Method Detail
  - addMessageId
```
public void addMessageId(long id)
```
    Add an ID to the list of the TunnelDataMssages this message was fragmented into. Unused except in notePreprocessing() calls for debugging
    Parameters:
    id - the message ID to add
  - drop
```
public void drop()
```
    For CDQ
    Specified by:
    drop in interface CDQEntry
  - getData
```
public byte[] getData()
```
    The raw unfragmented message to send.
    Returns:
    the message data
  - getEnqueueTime
```
public long getEnqueueTime()
```
    For CDQ
    Specified by:
    getEnqueueTime in interface CDQEntry
    Returns:
    the enqueue time
  - getExpiration
```
public long getExpiration()
```
    Returns:
    the message expiration
  - getFragmentNumber
```
public int getFragmentNumber()
```
    Which fragment are we working on (0 for the first fragment).
    Returns:
    the fragment number
  - getLifetime
```
public long getLifetime()
```
    Returns:
    the lifetime in milliseconds
  - getMessageId
```
public long getMessageId()
```
    Returns:
    the message ID
  - getMessageIds
```
public List<Long> getMessageIds()
```
    The IDs of the TunnelDataMssages this message was fragmented into. Unused except in notePreprocessing() calls for debugging
    Returns:
    non-null list of message IDs
  - getOffset
```
public int getOffset()
```
    The index into the data to be sent.
    Returns:
    the offset
  - getToRouter
```
public Hash getToRouter()
```
    The destination router.
    Returns:
    may be null
  - getToTunnel
```
public TunnelId getToTunnel()
```
    The destination tunnel.
    Returns:
    may be null
  - incrementFragmentNumber
```
public void incrementFragmentNumber()
```
    ok, fragment sent, increment what the next will be
  - setEnqueueTime
```
public void setEnqueueTime(long now)
```
    For CDQ
    Specified by:
    setEnqueueTime in interface CDQEntry
    Parameters:
    now - the enqueue timestamp
  - setOffset
```
public void setOffset(int offset)
```
    Move the offset.
    Parameters:
    offset - the new offset value
  - toString
```
public String toString()
```
    toString.
    Overrides:
    toString in class Object

Class PendingGatewayMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_created

_expiration

_fragmentNumber

_messageId

_offset

_remaining

_toRouter

_toTunnel

Constructor Detail

PendingGatewayMessage

Method Detail

addMessageId

drop

getData

getEnqueueTime

getExpiration

getFragmentNumber

getLifetime

getMessageId

getMessageIds

getOffset

getToRouter

getToTunnel

incrementFragmentNumber

setEnqueueTime

setOffset

toString