net.i2p.data.i2np
Class DeliveryStatusMessage

java.lang.Object
  extended by net.i2p.data.DataStructureImpl
      extended by net.i2p.data.i2np.I2NPMessageImpl
          extended by net.i2p.data.i2np.FastI2NPMessageImpl
              extended by net.i2p.data.i2np.DeliveryStatusMessage
All Implemented Interfaces:
DataStructure, I2NPMessage

public class DeliveryStatusMessage
extends FastI2NPMessageImpl

Defines the message sent back in reply to a message when requested, containing the private ack id.

Author:
jrandom

Nested Class Summary
 
Nested classes/interfaces inherited from class net.i2p.data.i2np.I2NPMessageImpl
I2NPMessageImpl.Builder
 
Field Summary
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, _uniqueId, CHECKSUM_LENGTH, DEFAULT_EXPIRATION_MS, HEADER_LENGTH
 
Fields inherited from interface net.i2p.data.i2np.I2NPMessage
MAX_ID_VALUE, MAX_SIZE
 
Constructor Summary
DeliveryStatusMessage(I2PAppContext context)
           
 
Method Summary
protected  int calculateWrittenLength()
          calculate the message body's length (not including the header and footer
 boolean equals(Object object)
           
 long getArrival()
          Misnamed, as it is generally (always?) set by the creator to the current time, in some future usage it could be set on arrival
 long getMessageId()
           
 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 setArrival(long arrival)
          Misnamed, as it is generally (always?) set by the creator to the current time, in some future usage it could be set on arrival
 void setMessageId(long 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, readBytes, readBytes, toByteArray, toByteArrayWithSavedChecksum, writeBytes
 
Methods inherited from class net.i2p.data.i2np.I2NPMessageImpl
createMessage, fromRawByteArray, getMessageExpiration, getMessageSize, getRawMessageSize, getUniqueId, readBytes, readMessage, registerBuilder, setMessageExpiration, setUniqueId, toByteArray, toRawByteArray
 
Methods inherited from class net.i2p.data.DataStructureImpl
calculateHash, fromBase64, fromByteArray, read, toBase64
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface net.i2p.data.DataStructure
calculateHash, fromBase64, fromByteArray, toBase64
 

Field Detail

MESSAGE_TYPE

public static final int MESSAGE_TYPE
See Also:
Constant Field Values
Constructor Detail

DeliveryStatusMessage

public DeliveryStatusMessage(I2PAppContext context)
Method Detail

getMessageId

public long getMessageId()

setMessageId

public void setMessageId(long id)
Throws:
IllegalStateException - if id previously set, to protect saved checksum

getArrival

public long getArrival()
Misnamed, as it is generally (always?) set by the creator to the current time, in some future usage it could be set on arrival


setArrival

public void setArrival(long arrival)
Misnamed, as it is generally (always?) set by the creator to the current time, in some future usage it could be set on arrival


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.

calculateWrittenLength

protected int calculateWrittenLength()
calculate the message body's length (not including the header and footer

Specified by:
calculateWrittenLength in class I2NPMessageImpl

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
Throws:
I2NPMessageException

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

equals

public boolean equals(Object object)
Overrides:
equals in class Object

toString

public String toString()
Overrides:
toString in class Object