DeliveryInstructions (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.DataStructureImpl
- - net.i2p.data.i2np.DeliveryInstructions

All Implemented Interfaces:
Serializable, DataStructure
```
public class DeliveryInstructions
extends DataStructureImpl
```
Contains the delivery instructions for garlic cloves. Generic "delivery instructions" are used both in tunnel messages and in garlic cloves, with slight differences. However, the tunnel message generator TrivialPreprocessor and reader FragmentHandler do not use this class, the reading and writing is handled inline there.
See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DELIVERY_MODE_DESTINATION` DELIVERY_MODE_DESTINATION.
`static int`	`DELIVERY_MODE_LOCAL` DELIVERY_MODE_LOCAL.
`static int`	`DELIVERY_MODE_ROUTER` DELIVERY_MODE_ROUTER.
`static int`	`DELIVERY_MODE_TUNNEL` DELIVERY_MODE_TUNNEL.
`static DeliveryInstructions`	`LOCAL` Immutable local instructions, no options

Constructor Summary
Constructors
Constructor and Description
DeliveryInstructions()
DeliveryInstructions.

Constructors
Constructor and Description
`DeliveryInstructions()` DeliveryInstructions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DeliveryInstructions`	`create(byte[] data, int offset)` Returns immutable local instructions, or new
`boolean`	`equals(Object obj)` Compare the delivery instructions for equality, including mode, delay, and target fields.
`boolean`	`getDelayRequested()` Defaults to false.
`long`	`getDelaySeconds()` Defaults to 0.
`int`	`getDeliveryMode()` Default -1.
`Hash`	`getDestination()` Default null.
`SessionKey`	`getEncryptionKey()` For cloves only (not tunnels), default null Unused — always returns null, feature not implemented.
`Hash`	`getRouter()` Default null.
`int`	`getSize()` Size of the serialized delivery instructions in bytes.
`TunnelId`	`getTunnelId()` Default null.
`int`	`hashCode()` Hash code combining the delay, mode, and target fields.
`int`	`readBytes(byte[] data, int offset)` Populate the delivery instructions from the byte array, starting at the given offset.
`void`	`readBytes(InputStream in)` Not supported, use readBytes(byte[], int)
`void`	`setDelayRequested(boolean req)` Defaults to false.
`void`	`setDelaySeconds(long seconds)` Defaults to 0.
`void`	`setDeliveryMode(int mode)` Delivery mode of the message.
`void`	`setDestination(Hash dest)` Required for DESTINATION.
`void`	`setRouter(Hash router)` Required for ROUTER or TUNNEL.
`void`	`setTunnelId(TunnelId id)` Required for TUNNEL.
`String`	`toString()` String form for debugging, showing the mode and any delay or target fields.
`int`	`writeBytes(byte[] target, int offset)` Serialize the delivery instructions into the byte array, starting at the given offset.
`void`	`writeBytes(OutputStream out)` Not supported, use writeBytes(byte[], int)

Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64, toByteArray

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

- Field Detail
  - DELIVERY_MODE_DESTINATION
```
public static final int DELIVERY_MODE_DESTINATION
```
    DELIVERY_MODE_DESTINATION.
    See Also:
    Constant Field Values
  - DELIVERY_MODE_LOCAL
```
public static final int DELIVERY_MODE_LOCAL
```
    DELIVERY_MODE_LOCAL.
    See Also:
    Constant Field Values
  - DELIVERY_MODE_ROUTER
```
public static final int DELIVERY_MODE_ROUTER
```
    DELIVERY_MODE_ROUTER.
    See Also:
    Constant Field Values
  - DELIVERY_MODE_TUNNEL
```
public static final int DELIVERY_MODE_TUNNEL
```
    DELIVERY_MODE_TUNNEL.
    See Also:
    Constant Field Values
  - LOCAL
```
public static final DeliveryInstructions LOCAL
```
    Immutable local instructions, no options
- Constructor Detail
  - DeliveryInstructions
```
public DeliveryInstructions()
```
    DeliveryInstructions.
- Method Detail
  - create
```
public static DeliveryInstructions create(byte[] data,
                                          int offset)
```
    Returns immutable local instructions, or new
  - equals
```
public boolean equals(Object obj)
```
    Compare the delivery instructions for equality, including mode, delay, and target fields.
    Overrides:
    equals in class Object
  - getDelayRequested
```
public boolean getDelayRequested()
```
    Defaults to false. Obsolete — delay not implemented in this release.
    Returns:
    the delay requested
  - getDelaySeconds
```
public long getDelaySeconds()
```
    Defaults to 0. Obsolete — delay not implemented in this release.
    Returns:
    the delay seconds
  - getDeliveryMode
```
public int getDeliveryMode()
```
    Default -1.
  - getDestination
```
public Hash getDestination()
```
    Default null.
  - getEncryptionKey
```
public SessionKey getEncryptionKey()
```
    For cloves only (not tunnels), default null Unused — always returns null, feature not implemented.
    Returns:
    the encryption key
  - getRouter
```
public Hash getRouter()
```
    Default null.
  - getSize
```
public int getSize()
```
    Size of the serialized delivery instructions in bytes.
    Returns:
    the size
  - getTunnelId
```
public TunnelId getTunnelId()
```
    Default null.
  - hashCode
```
public int hashCode()
```
    Hash code combining the delay, mode, and target fields.
    Overrides:
    hashCode in class Object
    Returns:
    the hash code
  - readBytes
```
public int readBytes(byte[] data,
                     int offset)
```
    Populate the delivery instructions from the byte array, starting at the given offset.
    Returns:
    the number of bytes read
  - readBytes
```
public void readBytes(InputStream in)
```
    Not supported, use readBytes(byte[], int)
    Parameters:
    in - stream to read from
    Throws:
    UnsupportedOperationException - always
  - setDelayRequested
```
public void setDelayRequested(boolean req)
```
    Defaults to false. Obsolete — delay not implemented in this release.
  - setDelaySeconds
```
public void setDelaySeconds(long seconds)
```
    Defaults to 0. Obsolete — delay not implemented in this release.
  - setDeliveryMode
```
public void setDeliveryMode(int mode)
```
    Delivery mode of the message.
    Parameters:
    mode - 0-3
  - setDestination
```
public void setDestination(Hash dest)
```
    Required for DESTINATION.
  - setRouter
```
public void setRouter(Hash router)
```
    Required for ROUTER or TUNNEL.
  - setTunnelId
```
public void setTunnelId(TunnelId id)
```
    Required for TUNNEL.
  - toString
```
public String toString()
```
    String form for debugging, showing the mode and any delay or target fields.
    Overrides:
    toString in class Object
  - writeBytes
```
public int writeBytes(byte[] target,
                      int offset)
```
    Serialize the delivery instructions into the byte array, starting at the given offset.
    Returns:
    the number of bytes written to the target
  - writeBytes
```
public void writeBytes(OutputStream out)
```
    Not supported, use writeBytes(byte[], int)
    Parameters:
    out - stream to write to
    Throws:
    UnsupportedOperationException - always

Class DeliveryInstructions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.DataStructureImpl

Methods inherited from class java.lang.Object

Field Detail

DELIVERY_MODE_DESTINATION

DELIVERY_MODE_LOCAL

DELIVERY_MODE_ROUTER

DELIVERY_MODE_TUNNEL

LOCAL

Constructor Detail

DeliveryInstructions

Method Detail

create

equals

getDelayRequested

getDelaySeconds

getDeliveryMode

getDestination

getEncryptionKey

getRouter

getSize

getTunnelId

hashCode

readBytes

readBytes

setDelayRequested

setDelaySeconds

setDeliveryMode

setDestination

setRouter

setTunnelId

toString

writeBytes

writeBytes