DatabaseStoreMessage (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.data.i2np.I2NPMessageImpl
- - net.i2p.data.i2np.FastI2NPMessageImpl
  - - net.i2p.data.i2np.DatabaseStoreMessage

All Implemented Interfaces:
I2NPMessage
```
public class DatabaseStoreMessage
extends FastI2NPMessageImpl
```
Defines the message a router sends to another router to test the network database reachability, as well as the reply message sent back. TODO: Don't decompress and recompress RouterInfos at the OBEP and IBGW. Could this even change the message length or corrupt things?

Nested Class Summary
- Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
  I2NPMessageImpl.Builder

Field Summary
Fields
Modifier and Type Field and Description
static int MESSAGE_TYPE
MESSAGE_TYPE.
- Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
  _checksum, _hasChecksum
- Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl
  _context, _expiration, _log, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTH
- Fields inherited from interface net.i2p.data.i2np.I2NPMessage
  MAX_ID_VALUE, MAX_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`MESSAGE_TYPE` MESSAGE_TYPE.

Constructor Summary
Constructors
Constructor and Description
DatabaseStoreMessage(I2PAppContext context)
Creates a new DatabaseStoreMessage.

Constructors
Constructor and Description
`DatabaseStoreMessage(I2PAppContext context)` Creates a new DatabaseStoreMessage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`calculateWrittenLength()` Calculate the message body's length (not including the header and footer)
`boolean`	`equals(Object object)` Compares this message to another for equality of all fields.
`DatabaseEntry`	`getEntry()` Defines the entry in the network database being stored.
`Hash`	`getKey()` Defines the key in the network database being stored.
`boolean`	`getReceivedAsReply()` If true, we received this by searching for it.
`Hash`	`getReplyGateway()` The gateway to send the reply to, or null if no reply is requested.
`long`	`getReplyToken()` If a reply is desired, this token specifies the message ID that should be used for a DeliveryStatusMessage to be sent to the reply tunnel on the reply gateway.
`TunnelId`	`getReplyTunnel()` The tunnel to send the reply through, or null if no reply is requested.
`int`	`getType()` The message type.
`int`	`hashCode()` Hash code calculated from the message fields.
`void`	`readMessage(byte[] data, int offset, int dataSize, int type)` Reads the message fields from the byte array.
`void`	`setEntry(DatabaseEntry entry)` This also sets the key
`void`	`setReceivedAsReply()` Records that this message was received by searching for it.
`void`	`setReplyGateway(Hash peer)` Assigns the gateway to send the reply to.
`void`	`setReplyToken(long token)` Update the reply token.
`void`	`setReplyTunnel(TunnelId id)` Assigns the tunnel to send the reply through.
`String`	`toString()` String form of the message, suitable for debugging.
`protected int`	`writeMessageBody(byte[] out, int curIndex)` Write the message body to the output array, starting at the given index.

Methods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl
readBytes, toByteArray, toByteArrayWithSavedChecksum

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, fromRawByteArrayNTCP2, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, getUniqueId, readBytes, readMessage, setMessageExpiration, setUniqueId, toByteArray, toByteArray, toRawByteArray, toRawByteArrayNTCP2

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

- Field Detail
  - MESSAGE_TYPE
```
public static final int MESSAGE_TYPE
```
    MESSAGE_TYPE.
    See Also:
    Constant Field Values
- Constructor Detail
  - DatabaseStoreMessage
```
public DatabaseStoreMessage(I2PAppContext context)
```
    Creates a new DatabaseStoreMessage.
    Parameters:
    context - the I2P app context
- Method Detail
  - calculateWrittenLength
```
protected int calculateWrittenLength()
```
    Calculate the message body's length (not including the header and footer)
    Specified by:
    calculateWrittenLength in class I2NPMessageImpl
    Returns:
    the length of the message body
    Throws:
    IllegalStateException - if the entry is not set
  - equals
```
public boolean equals(Object object)
```
    Compares this message to another for equality of all fields.
    Overrides:
    equals in class Object
  - getEntry
```
public DatabaseEntry getEntry()
```
    Defines the entry in the network database being stored.
    Returns:
    the database entry
  - getKey
```
public Hash getKey()
```
    Defines the key in the network database being stored.
    Returns:
    the key, or null if not set
  - getReceivedAsReply
```
public boolean getReceivedAsReply()
```
    If true, we received this by searching for it. Note that searches may query multiple peers in parallel; only the first reply may have this set, and a reply received after the reply job times out will not have this set. Default false.
    Returns:
    the received as reply
  - getReplyGateway
```
public Hash getReplyGateway()
```
    The gateway to send the reply to, or null if no reply is requested.
    Returns:
    the reply gateway, or null
  - getReplyToken
```
public long getReplyToken()
```
    If a reply is desired, this token specifies the message ID that should be used for a DeliveryStatusMessage to be sent to the reply tunnel on the reply gateway.
    Returns:
    positive reply token ID, or 0 if no reply is necessary.
  - getReplyTunnel
```
public TunnelId getReplyTunnel()
```
    The tunnel to send the reply through, or null if no reply is requested.
    Returns:
    the reply tunnel, or null
  - getType
```
public int getType()
```
    The message type.
    Returns:
    the type
  - hashCode
```
public int hashCode()
```
    Hash code calculated from the message fields.
    Overrides:
    hashCode in class Object
    Returns:
    the hash code
  - readMessage
```
public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException
```
    Reads the message fields from the byte array.
    Parameters:
    data - data to read from
    offset - where to start in the data array
    dataSize - how long into the data to read
    type - I2NP message type
    Throws:
    I2NPMessageException - if the stream doesn't contain a valid message that this class can read.
  - setEntry
```
public void setEntry(DatabaseEntry entry)
```
    This also sets the key
    Parameters:
    entry - the entry to store
    Throws:
    IllegalStateException - if data previously set, to protect saved checksum
  - setReceivedAsReply
```
public void setReceivedAsReply()
```
    Records that this message was received by searching for it.
  - setReplyGateway
```
public void setReplyGateway(Hash peer)
```
    Assigns the gateway to send the reply to.
    Parameters:
    peer - the reply gateway
  - setReplyToken
```
public void setReplyToken(long token)
                   throws IllegalArgumentException
```
    Update the reply token.
    Throws:
    IllegalArgumentException - if the token is out of range (min=0, max=I2NPMessage.MAX_ID_VALUE)
  - setReplyTunnel
```
public void setReplyTunnel(TunnelId id)
```
    Assigns the tunnel to send the reply through.
    Parameters:
    id - the reply tunnel
  - toString
```
public String toString()
```
    String form of the message, suitable for debugging.
    Overrides:
    toString in class Object
  - writeMessageBody
```
protected int writeMessageBody(byte[] out,
                               int curIndex)
                        throws I2NPMessageException
```
    Write the message body to the output array, starting at the given index.
    Specified by:
    writeMessageBody in class I2NPMessageImpl
    Returns:
    the index into the array after the last byte written (NOT the length)
    Throws:
    I2NPMessageException

Class DatabaseStoreMessage

Nested Class Summary

Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl

Field Summary

Fields inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Fields inherited from class net.i2p.data.i2np.I2NPMessageImpl

Fields inherited from interface net.i2p.data.i2np.I2NPMessage

Constructor Summary

Method Summary

Methods inherited from class net.i2p.data.i2np.FastI2NPMessageImpl

Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_TYPE

Constructor Detail

DatabaseStoreMessage

Method Detail

calculateWrittenLength

equals

getEntry

getKey

getReceivedAsReply

getReplyGateway

getReplyToken

getReplyTunnel

getType

hashCode

readMessage

setEntry

setReceivedAsReply

setReplyGateway

setReplyToken

setReplyTunnel

toString

writeMessageBody