net.i2p.data.i2np

Class DatabaseStoreMessage

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

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

Constructor Summary

Constructors

Constructor and Description
DatabaseStoreMessage(I2PAppContext context)

Method Summary

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)
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()
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()
int	getType() Return the unique identifier for this type of I2NP message, as defined in the I2NP spec
int	hashCode()
void	readMessage(byte[] data, int offset, int dataSize, int type) Read the body into the data structures, after the initial type byte and the uniqueId / expiration, using the current class's format as defined by the I2NP specification
void	setEntry(DatabaseEntry entry) This also sets the key
void	setReceivedAsReply() set to true
void	setReplyGateway(Hash peer)
void	setReplyToken(long token) Update the reply token.
void	setReplyTunnel(TunnelId id)
String	toString()
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

See Also:

Constant Field Values

Constructor Detail

DatabaseStoreMessage

public DatabaseStoreMessage(I2PAppContext 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

Throws:

IllegalStateException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getEntry

public DatabaseEntry getEntry()

Defines the entry in the network database being stored

getKey

public Hash getKey()

Defines the key in the network database being stored

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.

getReplyGateway

public Hash getReplyGateway()

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()

getType

public int getType()

Description copied from interface: I2NPMessage

Return the unique identifier for this type of I2NP message, as defined in the I2NP spec

hashCode

public int hashCode()

Overrides:

hashCode in class Object

readMessage

public void readMessage(byte[] data,
                        int offset,
                        int dataSize,
                        int type)
                 throws I2NPMessageException

Description copied from interface: I2NPMessage

Read the body into the data structures, after the initial type byte and the uniqueId / expiration, using the current class's format as defined by the I2NP specification

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

Throws:

IllegalStateException - if data previously set, to protect saved checksum

setReceivedAsReply

public void setReceivedAsReply()

set to true

setReplyGateway

public void setReplyGateway(Hash peer)

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)

toString

public String toString()

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