Datagram3 (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.client.datagram.Datagram3

public class Datagram3
extends Object

Class for creating and loading I2P repliable datagrams version 3. Ref: Proposal 163

 +----+----+----+----+----+----+----+----+
 |                                       |
 +            fromHash                   +
 |                                       |
 +                                       +
 |                                       |
 +----+----+----+----+----+----+----+----+
 |  flags  |     options (optional)      |
 +----+----+                             +
 ~                                       ~
 ~                                       ~
 +----+----+----+----+----+----+----+----+
 |                                       |
 ~            payload                    ~
 ~                                       ~
 |                                       |
 +----+----+----+----+----+----+----+----+

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Properties`	`getOptions()` Get the options of an I2P repliable datagram (previously loaded with the load() method), if any
`byte[]`	`getPayload()` Get the payload carried by an I2P repliable datagram (previously loaded with the load() method)
`Hash`	`getSender()` Get the sender of an I2P repliable datagram (previously loaded with the load() method)
`static Datagram3`	`load(I2PAppContext ctx, I2PSession session, byte[] dgram)` Load an I2P repliable datagram3.
`static byte[]`	`make(I2PAppContext ctx, I2PSession session, byte[] payload)` Make a repliable I2P datagram3 containing the specified payload.
`static byte[]`	`make(I2PAppContext ctx, I2PSession session, byte[] payload, Properties options)` Make a repliable I2P datagram3 containing the specified payload.

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

- Method Detail
  - getOptions
```
public Properties getOptions()
```
    Get the options of an I2P repliable datagram (previously loaded with the load() method), if any
    Returns:
    options or null
  - getPayload
```
public byte[] getPayload()
```
    Get the payload carried by an I2P repliable datagram (previously loaded with the load() method)
    Returns:
    A byte array containing the datagram payload
  - getSender
```
public Hash getSender()
```
    Get the sender of an I2P repliable datagram (previously loaded with the load() method)
    Returns:
    The Hash of the Destination of the I2P repliable datagram sender
  - load
```
public static Datagram3 load(I2PAppContext ctx,
                             I2PSession session,
                             byte[] dgram)
                      throws DataFormatException
```
    Load an I2P repliable datagram3.
    Parameters:
    ctx - non-null
    session - non-null
    dgram - non-null I2P repliable datagram to be loaded
    Returns:
    non-null, throws on all errors
    Throws:
    DataFormatException - If there is an error in the datagram format
  - make
```
public static byte[] make(I2PAppContext ctx,
                          I2PSession session,
                          byte[] payload)
                   throws DataFormatException
```
    Make a repliable I2P datagram3 containing the specified payload.
    Parameters:
    ctx - non-null
    session - non-null
    payload - non-null Bytes to be contained in the I2P datagram.
    Returns:
    non-null, throws on all errors
    Throws:
    DataFormatException - if payload is too big
  - make
```
public static byte[] make(I2PAppContext ctx,
                          I2PSession session,
                          byte[] payload,
                          Properties options)
                   throws DataFormatException
```
    Make a repliable I2P datagram3 containing the specified payload.
    Parameters:
    ctx - non-null
    session - non-null
    payload - non-null Bytes to be contained in the I2P datagram.
    options - may be null
    Returns:
    non-null, throws on all errors
    Throws:
    DataFormatException - if payload is too big

Class Datagram3

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getOptions

getPayload

getSender

load

make

make