net.i2p.data.i2cp
Class MessagePayloadMessage
java.lang.Object
net.i2p.data.DataStructureImpl
net.i2p.data.i2cp.I2CPMessageImpl
net.i2p.data.i2cp.MessagePayloadMessage
- All Implemented Interfaces:
- DataStructure, I2CPMessage
public class MessagePayloadMessage
- extends I2CPMessageImpl
Defines the message a client sends to a router to ask it to deliver
a new message
- Author:
- jrandom
Method Summary |
protected void |
doReadMessage(java.io.InputStream in,
int size)
Read in the payload part of the message (after the initial 4 byte size and 1
byte type) |
protected byte[] |
doWriteMessage()
Write out the payload part of the message (not including the 4 byte size and
1 byte type) |
boolean |
equals(java.lang.Object object)
|
long |
getMessageId()
|
Payload |
getPayload()
|
long |
getSessionId()
|
int |
getType()
Return the unique identifier for this type of APIMessage, as specified in the
network specification document under #ClientAccessLayerMessages |
void |
setMessageId(long id)
|
void |
setPayload(Payload payload)
|
void |
setSessionId(long id)
|
java.lang.String |
toString()
|
void |
writeMessage(java.io.OutputStream out)
Write out the full message to the stream, including the 4 byte size and 1
byte type header. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MESSAGE_TYPE
public static final int MESSAGE_TYPE
- See Also:
- Constant Field Values
MessagePayloadMessage
public MessagePayloadMessage()
getSessionId
public long getSessionId()
setSessionId
public void setSessionId(long id)
getMessageId
public long getMessageId()
setMessageId
public void setMessageId(long id)
getPayload
public Payload getPayload()
setPayload
public void setPayload(Payload payload)
doReadMessage
protected void doReadMessage(java.io.InputStream in,
int size)
throws I2CPMessageException,
java.io.IOException
- Description copied from class:
I2CPMessageImpl
- Read in the payload part of the message (after the initial 4 byte size and 1
byte type)
- Specified by:
doReadMessage
in class I2CPMessageImpl
- Throws:
I2CPMessageException
java.io.IOException
doWriteMessage
protected byte[] doWriteMessage()
throws I2CPMessageException,
java.io.IOException
- Description copied from class:
I2CPMessageImpl
- Write out the payload part of the message (not including the 4 byte size and
1 byte type)
- Specified by:
doWriteMessage
in class I2CPMessageImpl
- Throws:
I2CPMessageException
java.io.IOException
writeMessage
public void writeMessage(java.io.OutputStream out)
throws I2CPMessageException,
java.io.IOException
- Write out the full message to the stream, including the 4 byte size and 1
byte type header.
- Specified by:
writeMessage
in interface I2CPMessage
- Overrides:
writeMessage
in class I2CPMessageImpl
- Throws:
I2CPMessageException
- if the current object doesn't have sufficient data
to write a properly formatted message.
java.io.IOException
- if there is a problem writing to the stream
getType
public int getType()
- Description copied from interface:
I2CPMessage
- Return the unique identifier for this type of APIMessage, as specified in the
network specification document under #ClientAccessLayerMessages
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in class java.lang.Object
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object