InboundMessageState (Javadocs [I2P+ 2.13.0+]

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

All Implemented Interfaces:
CDQEntry
```
class InboundMessageState
extends Object
implements CDQEntry
```
Hold the raw data fragments of an inbound message.

Field Summary
Fields
Modifier and Type Field and Description
static int MAX_FRAGMENTS
Maximum number of fragments per message.

Fields
Modifier and Type	Field and Description
`static int`	`MAX_FRAGMENTS` Maximum number of fragments per message.

Constructor Summary

Constructors
Constructor and Description
`InboundMessageState(RouterContext ctx, long messageId, Hash from)` Constructs a new InboundMessageState with no fragments.
`InboundMessageState(RouterContext ctx, long messageId, Hash from, byte[] data, int off, int len, int fragmentNum, boolean isLast)` Constructs and initializes by receiving one fragment.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ACKBitfield`	`createACKBitfield()` Creates a bitfield representing received fragments.
`void`	`drop()` Drops and releases resources.
`int`	`getCompleteSize()` Returns the total size of the complete message in bytes.
`long`	`getEnqueueTime()` Gets the enqueue time.
`int`	`getFragmentCount()` Returns number of fragments received or expected.
`ByteArray[]`	`getFragments()` Returns the array of fragments, throws if already released.
`Hash`	`getFrom()` Returns the Hash of the sender.
`long`	`getLifetime()` Returns the message lifetime in milliseconds.
`long`	`getMessageId()` Returns the message ID.
`boolean`	`hasFragment(int fragmentNum)` Returns whether the specified fragment has been received.
`boolean`	`isComplete()` Returns true if all fragments up to last have been received.
`boolean`	`isExpired()` Returns true if message has expired (received more than 10s ago).
`boolean`	`receiveFragment(byte[] data, int off, int len, int fragmentNum, boolean isLast)` Receives and stores a fragment.
`void`	`releaseResources()` Releases all cached fragments and marks this state as released.
`void`	`setEnqueueTime(long now)` Sets enqueue time for queueing.
`String`	`toString()` Returns a string summary of this message state.

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

- Field Detail
  - MAX_FRAGMENTS
```
public static final int MAX_FRAGMENTS
```
    Maximum number of fragments per message.
    See Also:
    Constant Field Values
- Constructor Detail
  - InboundMessageState
```
public InboundMessageState(RouterContext ctx,
                           long messageId,
                           Hash from)
```
    Constructs a new InboundMessageState with no fragments.
    Parameters:
    ctx - the ctx
  - InboundMessageState
```
public InboundMessageState(RouterContext ctx,
                           long messageId,
                           Hash from,
                           byte[] data,
                           int off,
                           int len,
                           int fragmentNum,
                           boolean isLast)
                    throws DataFormatException
```
    Constructs and initializes by receiving one fragment.
    Parameters:
    ctx - the ctx
    Throws:
    DataFormatException - if fragment is invalid
- Method Detail
  - createACKBitfield
```
public ACKBitfield createACKBitfield()
```
    Creates a bitfield representing received fragments.
    Returns:
    the value
  - drop
```
public void drop()
```
    Drops and releases resources.
    Specified by:
    drop in interface CDQEntry
  - getCompleteSize
```
public int getCompleteSize()
```
    Returns the total size of the complete message in bytes.
    Returns:
    the complete size
    Throws:
    IllegalStateException - if message incomplete or released
  - getEnqueueTime
```
public long getEnqueueTime()
```
    Gets the enqueue time.
    Specified by:
    getEnqueueTime in interface CDQEntry
    Returns:
    the enqueue time
  - getFragmentCount
```
public int getFragmentCount()
```
    Returns number of fragments received or expected.
    Returns:
    the fragment count
  - getFragments
```
public ByteArray[] getFragments()
```
    Returns the array of fragments, throws if already released.
    Returns:
    the fragments
  - getFrom
```
public Hash getFrom()
```
    Returns the Hash of the sender.
    Returns:
    the from
  - getLifetime
```
public long getLifetime()
```
    Returns the message lifetime in milliseconds.
    Returns:
    the lifetime
  - getMessageId
```
public long getMessageId()
```
    Returns the message ID.
    Returns:
    the message id
  - hasFragment
```
public boolean hasFragment(int fragmentNum)
```
    Returns whether the specified fragment has been received.
    Parameters:
    fragmentNum - the fragmentNum
    Returns:
    whether fragment is present
  - isComplete
```
public boolean isComplete()
```
    Returns true if all fragments up to last have been received.
    Returns:
    whether complete
  - isExpired
```
public boolean isExpired()
```
    Returns true if message has expired (received more than 10s ago).
    Returns:
    whether expired
  - receiveFragment
```
public boolean receiveFragment(byte[] data,
                               int off,
                               int len,
                               int fragmentNum,
                               boolean isLast)
```
    Receives and stores a fragment.
    Parameters:
    data - the data
    Returns:
    true if successful, false if corrupt or invalid
  - releaseResources
```
public void releaseResources()
```
    Releases all cached fragments and marks this state as released.
  - setEnqueueTime
```
public void setEnqueueTime(long now)
```
    Sets enqueue time for queueing.
    Specified by:
    setEnqueueTime in interface CDQEntry
    Parameters:
    now - the enqueue timestamp
  - toString
```
public String toString()
```
    Returns a string summary of this message state.
    Overrides:
    toString in class Object

Class InboundMessageState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_FRAGMENTS

Constructor Detail

InboundMessageState

InboundMessageState

Method Detail

createACKBitfield

drop

getCompleteSize

getEnqueueTime

getFragmentCount

getFragments

getFrom

getLifetime

getMessageId

hasFragment

isComplete

isExpired

receiveFragment

releaseResources

setEnqueueTime

toString