FragmentedMessage (Javadocs [I2P+ 2.13.0+]

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

```
class FragmentedMessage
extends Object
```
Gather fragments of I2NPMessages at a tunnel endpoint, making them available for reading when complete. Warning - this is all unsynchronized here - receivers must implement synchronization

Constructor Summary
Constructors
Constructor and Description
FragmentedMessage(I2PAppContext ctx, long messageId)
FragmentedMessage.

Constructors
Constructor and Description
`FragmentedMessage(I2PAppContext ctx, long messageId)` FragmentedMessage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`failed()` Releases the fragments, marking the message as failed.
`int`	`getCompleteSize()` The size of the complete message, in bytes.
`SimpleTimer2.TimedEvent`	`getExpireEvent()` Used in the fragment handler so we can cancel the expire event on success.
`int`	`getFragmentCount()` The number of fragments received so far.
`long`	`getLifetime()` How long has this fragmented message been alive?
`long`	`getMessageId()` The unique ID of this fragmented message.
`boolean`	`getReleased()` Whether this message has been released after completion.
`long`	`getReleasedAfter()` The lifetime at which the fragments were released, or 0 if not yet released.
`Hash`	`getTargetRouter()` The router this message is being sent to.
`TunnelId`	`getTargetTunnel()` The tunnel this message is being sent to.
`boolean`	`isComplete()` Have we received all of the fragments?
`boolean`	`receive(byte[] payload, int offset, int length, boolean isLast, Hash toRouter, TunnelId toTunnel)` Receive the first fragment (#0) and related metadata.
`boolean`	`receive(int fragmentNum, byte[] payload, int offset, int length, boolean isLast)` Receive a followup fragment, though one of these may arrive at the endpoint prior to the fragment # 0.
`void`	`setExpireEvent(SimpleTimer2.TimedEvent evt)` The expire event to cancel when this message completes.
`byte[]`	`toByteArray()` The complete reassembled message data, freeing the fragments.
`String`	`toString()` Debug description of the message ID and the received fragments.

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

- Constructor Detail
  - FragmentedMessage
```
public FragmentedMessage(I2PAppContext ctx,
                         long messageId)
```
    FragmentedMessage.
- Method Detail
  - failed
```
public void failed()
```
    Releases the fragments, marking the message as failed.
  - getCompleteSize
```
public int getCompleteSize()
```
    The size of the complete message, in bytes.
    Returns:
    the complete size
  - getExpireEvent
```
public SimpleTimer2.TimedEvent getExpireEvent()
```
    Used in the fragment handler so we can cancel the expire event on success.
  - getFragmentCount
```
public int getFragmentCount()
```
    The number of fragments received so far.
    Returns:
    the fragment count
  - getLifetime
```
public long getLifetime()
```
    How long has this fragmented message been alive?
  - getMessageId
```
public long getMessageId()
```
    The unique ID of this fragmented message.
    Returns:
    the message id
  - getReleased
```
public boolean getReleased()
```
    Whether this message has been released after completion.
    Returns:
    the released
  - getReleasedAfter
```
public long getReleasedAfter()
```
    The lifetime at which the fragments were released, or 0 if not yet released.
    Returns:
    the released after
  - getTargetRouter
```
public Hash getTargetRouter()
```
    The router this message is being sent to.
    Returns:
    the target router
  - getTargetTunnel
```
public TunnelId getTargetTunnel()
```
    The tunnel this message is being sent to.
    Returns:
    the target tunnel
  - isComplete
```
public boolean isComplete()
```
    Have we received all of the fragments?
  - receive
```
public boolean receive(byte[] payload,
                       int offset,
                       int length,
                       boolean isLast,
                       Hash toRouter,
                       TunnelId toTunnel)
```
    Receive the first fragment (#0) and related metadata. This may not be the first one to arrive at the endpoint however.
    Parameters:
    payload - data for the fragment non-null
    offset - index into the payload where the fragment data starts (past headers/etc)
    length - how much past the offset should we snag?
    isLast - is this the last fragment in the message?
    toRouter - what router is this destined for (may be null)
    toTunnel - what tunnel is this destined for (may be null)
  - receive
```
public boolean receive(int fragmentNum,
                       byte[] payload,
                       int offset,
                       int length,
                       boolean isLast)
```
    Receive a followup fragment, though one of these may arrive at the endpoint prior to the fragment # 0.
    Parameters:
    fragmentNum - sequence number within the message (1 - 63)
    payload - data for the fragment non-null
    offset - index into the payload where the fragment data starts (past headers/etc)
    length - how much past the offset should we snag?
    isLast - is this the last fragment in the message?
  - setExpireEvent
```
public void setExpireEvent(SimpleTimer2.TimedEvent evt)
```
    The expire event to cancel when this message completes.
  - toByteArray
```
public byte[] toByteArray()
```
    The complete reassembled message data, freeing the fragments.
  - toString
```
public String toString()
```
    Debug description of the message ID and the received fragments.
    Overrides:
    toString in class Object

Class FragmentedMessage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FragmentedMessage

Method Detail

failed

getCompleteSize

getExpireEvent

getFragmentCount

getLifetime

getMessageId

getReleased

getReleasedAfter

getTargetRouter

getTargetTunnel

isComplete

receive

receive

setExpireEvent

toByteArray

toString