Message (TomP2P Core 5.0-Alpha2 API)

java.lang.Object
- net.tomp2p.message.Message

```
public class Message
extends Object
```
The message is in binary format in TomP2P. It is defined as follows and has several header and payload fields. Since we do the serialization manually, we do not need a serialization field.

Author:

Thomas Bocek

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Message.Content
8 x 4 bit.

static class Message.Type
1 x 4 bit.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.Content` 8 x 4 bit.
`static class`	`Message.Type` 1 x 4 bit.

Field Summary

Fields
Modifier and Type Field and Description

static int CONTENT_TYPE_LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`CONTENT_TYPE_LENGTH`

Constructor Summary

Constructors
Constructor and Description

Message()
Creates message with a random ID.

Constructors
Constructor and Description
`Message()` Creates message with a random ID.

Method Summary

Methods
Modifier and Type	Method and Description
`Queue<NumberType>`	`contentRefencencs()`
`Message`	`done(boolean done)`
`SimpleBloomFilter<Number160>`	`getBloomFilter(int index)`
`List<SimpleBloomFilter<Number160>>`	`getBloomFilterList()`
`Buffer`	`getBuffer(int index)`
`List<Buffer>`	`getBufferList()`
`byte`	`getCommand()` Command of the message, such as GET, PING, etc.
`Message.Content[]`	`getContentTypes()` Return content types.
`DataMap`	`getDataMap(int index)`
`List<DataMap>`	`getDataMapList()`
`Integer`	`getInteger(int index)`
`List<Integer>`	`getIntegerList()`
`Number160`	`getKey(int index)`
`KeyCollection`	`getKeyCollection(int index)`
`List<KeyCollection>`	`getKeyCollectionList()`
`List<Number160>`	`getKeyList()`
`List<KeyMap640>`	`getKeyMap480List()`
`KeyMap640`	`getKeyMap640(int index)`
`KeyMapByte`	`getKeyMapByte(int index)`
`List<KeyMapByte>`	`getKeyMapByteList()`
`Long`	`getLong(int index)`
`List<Long>`	`getLongList()`
`int`	`getMessageId()` Randomly generated message ID.
`NeighborSet`	`getNeighborsSet(int index)`
`List<NeighborSet>`	`getNeighborsSetList()`
`int`	`getOptions()`
`List<PeerSocketAddress>`	`getPeerSocketAddresses()`
`PrivateKey`	`getPrivateKey()`
`PublicKey`	`getPublicKey()`
`PublicKey`	`getPublicKey(int index)`
`List<PublicKey>`	`getPublicKeyList()`
`PeerAddress`	`getRecipient()` The ID of the recipient.
`PeerAddress`	`getSender()` The ID of the sender.
`TrackerData`	`getTrackerData(int index)`
`List<TrackerData>`	`getTrackerDataList()`
`Message.Type`	`getType()` Determines if its a request oCommandr reply, and what kind of reply (error, warning states).
`int`	`getVersion()` Returns the version, which is 32bit.
`boolean`	`hasContent()`
`Message`	`hasContent(boolean content)`
`boolean`	`isDone()`
`boolean`	`isError()`
`static boolean`	`isError(Message.Type type)`
`boolean`	`isFireAndForget()`
`boolean`	`isKeepAlive()`
`boolean`	`isNotOk()`
`boolean`	`isOk()`
`boolean`	`isRequest()`
`boolean`	`isSign()`
`boolean`	`isStreaming()`
`boolean`	`isUdp()`
`Message`	`presetContentTypes(boolean presetContentTypes)` If we are setting values from the decoder, then the content type is already set.
`SHA1Signature`	`receivedSignature()`
`Message`	`receivedSignature(SHA1Signature signatureEncode)`
`InetSocketAddress`	`recipientSocket()`
`Message`	`recipientSocket(InetSocketAddress recipientSocket)` Store the recipient of the packet.
`void`	`restoreContentReferences()` Restore the content references if only the content types array is present.
`InetSocketAddress`	`senderSocket()`
`Message`	`senderSocket(InetSocketAddress senderSocket)` Store the sender of the packet.
`Message`	`setBloomFilter(SimpleBloomFilter<Number160> bloomFilter)`
`Message`	`setBuffer(Buffer byteBuf)`
`Message`	`setCommand(byte command)` Command of the message, such as GET, PING, etc.
`Message`	`setContentType(int index, Message.Content contentType)` Sets or replaces the content type at a specific index.
`Message`	`setContentType(Message.Content contentType)` Convenient method to set content type.
`Message`	`setContentTypes(Message.Content[] contentTypes)` Used for deserialization.
`Message`	`setDataMap(DataMap dataMap)`
`Message`	`setDone()` Set done to true if message decoding or encoding is done.
`Message`	`setHintSign()` Set if we have a signed message.
`Message`	`setInteger(int integer)`
`Message`	`setKeepAlive(boolean isKeepAlive)`
`Message`	`setKey(Number160 key)`
`Message`	`setKeyCollection(KeyCollection key)`
`Message`	`setKeyMap640(KeyMap640 keyMap)`
`Message`	`setKeyMapByte(KeyMapByte keyMap)`
`Message`	`setLong(long long0)`
`Message`	`setMessageId(int messageId)` For deserialization, we need to set the id.
`Message`	`setNeighborsSet(NeighborSet neighborSet)`
`Message`	`setOptions(int options)`
`Message`	`setPeerSocketAddresses(List<PeerSocketAddress> peerSocketAddresses)`
`Message`	`setPublicKey(PublicKey publicKey)`
`Message`	`setPublicKeyAndSign(KeyPair keyPair)`
`Message`	`setRecipient(PeerAddress recipient)` Set the ID of the recipient.
`Message`	`setSender(PeerAddress sender)` The ID of the sender.
`Message`	`setStreaming()`
`Message`	`setTrackerData(TrackerData trackerData)`
`Message`	`setType(Message.Type type)` Set the message type.
`Message`	`setVerified()`
`Message`	`setVersion(int version)` For deserialization.
`Signature`	`signatureForVerification()`
`Message`	`signatureForVerification(Signature signature, PublicKey receivedPublicKey)`
`Message`	`streaming(boolean streaming)`
`String`	`toString()`
`Message`	`udp(boolean udp)`
`boolean`	`verified()`
`Message`	`verified(boolean verified)`

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

- Field Detail
  - CONTENT_TYPE_LENGTH
```
public static final int CONTENT_TYPE_LENGTH
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Message
```
public Message()
```
    Creates message with a random ID.
- Method Detail
  - getMessageId
```
public int getMessageId()
```
    Randomly generated message ID.
    
    Returns:
    message Id
  - setMessageId
```
public Message setMessageId(int messageId)
```
    For deserialization, we need to set the id.
    
    Parameters:
    messageId - The message Id
    
    Returns:
    This class
  - getVersion
```
public int getVersion()
```
    Returns the version, which is 32bit. Each application can choose and version to not intefere with other applications
    
    Returns:
    The application version that uses this P2P framework
  - setVersion
```
public Message setVersion(int version)
```
    For deserialization.
    
    Parameters:
    version - The 24bit version
    
    Returns:
    This class
  - getType
```
public Message.Type getType()
```
    Determines if its a request oCommandr reply, and what kind of reply (error, warning states).
    
    Returns:
    Type of the message
  - setType
```
public Message setType(Message.Type type)
```
    Set the message type. Either its a request or reply (with error and warning codes).
    
    Parameters:
    type - Type of the message
    
    Returns:
    This class
  - getCommand
```
public byte getCommand()
```
    Command of the message, such as GET, PING, etc.
    
    Returns:
    Command
  - setCommand
```
public Message setCommand(byte command)
```
    Command of the message, such as GET, PING, etc.
    
    Parameters:
    command - Command
    
    Returns:
    This class
  - getSender
```
public PeerAddress getSender()
```
    The ID of the sender. Note that the IP is set via the socket.
    
    Returns:
    The ID of the sender.
  - setSender
```
public Message setSender(PeerAddress sender)
```
    The ID of the sender. The IP of the sender will *not* be transferred, as this information is in the IP packet.
    
    Parameters:
    sender - The ID of the sender.
    
    Returns:
    This class
  - getRecipient
```
public PeerAddress getRecipient()
```
    The ID of the recipient. Note that the IP is set via the socket.
    
    Returns:
    The ID of the recipient
  - setRecipient
```
public Message setRecipient(PeerAddress recipient)
```
    Set the ID of the recipient. The IP is used to connect to the recipient, but the IP is *not* transferred.
    
    Parameters:
    recipient - The ID of the recipient
    
    Returns:
    This class
  - getContentTypes
```
public Message.Content[] getContentTypes()
```
    Return content types. Content type can be empty if not set
    
    Returns:
    Content type 1
  - setContentType
```
public Message setContentType(Message.Content contentType)
```
    Convenient method to set content type. Set first content type 1, if this is set (not empty), then set the second one, etc.
    
    Parameters:
    contentType - The content type to set
    
    Returns:
    This class
  - restoreContentReferences
```
public void restoreContentReferences()
```
    Restore the content references if only the content types array is present. The content references are removed when deconing a message. That means if a message was received it cannot be used a second time as the content references are not there anymore. This method restores the content references based on the content types of the message.
  - setContentType
```
public Message setContentType(int index,
                     Message.Content contentType)
```
    Sets or replaces the content type at a specific index.
    
    Parameters:
    index - The index
    contentType - The content type
    
    Returns:
    This class
  - setContentTypes
```
public Message setContentTypes(Message.Content[] contentTypes)
```
    Used for deserialization.
    
    Parameters:
    contentTypes - The content types that were decoded.
    
    Returns:
    This class
  - contentRefencencs
```
public Queue<NumberType> contentRefencencs()
```
    Returns:
    The serialized content and references to the respective arrays
  - hasContent
```
public boolean hasContent()
```
    Returns:
    True if we have content and not only the header
  - hasContent
```
public Message hasContent(boolean content)
```
    Parameters:
    content - We can set this already in the header to know if we have content or not
    
    Returns:
    This class
  - isRequest
```
public boolean isRequest()
```
    Returns:
    True if this is a request, a regural or a fire and forget
  - isFireAndForget
```
public boolean isFireAndForget()
```
    Returns:
    True if its a fire and forget, that means we don't expect an answer
  - isOk
```
public boolean isOk()
```
    Returns:
    True if the message was ok, or at least send partial data
  - isNotOk
```
public boolean isNotOk()
```
    Returns:
    True if the message arrived, but data was not found or access was denied
  - isError
```
public boolean isError()
```
    Returns:
    True if the message contained an unexpected error or behavior
  - isError
```
public static boolean isError(Message.Type type)
```
    Parameters:
    type - The type to check
    
    Returns:
    True if the message contained an unexpected error or behavior
  - setOptions
```
public Message setOptions(int options)
```
    Parameters:
    options - The option from the last byte of the header
    
    Returns:
    This class
  - getOptions
```
public int getOptions()
```
    Returns:
    The option from the last byte of the header
  - setKeepAlive
```
public Message setKeepAlive(boolean isKeepAlive)
```
    Parameters:
    isKeepAlive - True if the connection should remain open. We need to announce this in the header, as otherwise the other end has an idle handler that will close the connection.
    
    Returns:
    This class
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Returns:
    True if this message was sent on a connection that should be kept alive
  - setStreaming
```
public Message setStreaming()
```
  - streaming
```
public Message streaming(boolean streaming)
```
  - isStreaming
```
public boolean isStreaming()
```
  - setKey
```
public Message setKey(Number160 key)
```
  - getKeyList
```
public List<Number160> getKeyList()
```
  - getKey
```
public Number160 getKey(int index)
```
  - setBloomFilter
```
public Message setBloomFilter(SimpleBloomFilter<Number160> bloomFilter)
```
  - getBloomFilterList
```
public List<SimpleBloomFilter<Number160>> getBloomFilterList()
```
  - getBloomFilter
```
public SimpleBloomFilter<Number160> getBloomFilter(int index)
```
  - setPublicKeyAndSign
```
public Message setPublicKeyAndSign(KeyPair keyPair)
```
  - setInteger
```
public Message setInteger(int integer)
```
  - getIntegerList
```
public List<Integer> getIntegerList()
```
  - getInteger
```
public Integer getInteger(int index)
```
  - setLong
```
public Message setLong(long long0)
```
  - getLongList
```
public List<Long> getLongList()
```
  - getLong
```
public Long getLong(int index)
```
  - setNeighborsSet
```
public Message setNeighborsSet(NeighborSet neighborSet)
```
  - getNeighborsSetList
```
public List<NeighborSet> getNeighborsSetList()
```
  - getNeighborsSet
```
public NeighborSet getNeighborsSet(int index)
```
  - setDataMap
```
public Message setDataMap(DataMap dataMap)
```
  - getDataMapList
```
public List<DataMap> getDataMapList()
```
  - getDataMap
```
public DataMap getDataMap(int index)
```
  - setKeyCollection
```
public Message setKeyCollection(KeyCollection key)
```
  - getKeyCollectionList
```
public List<KeyCollection> getKeyCollectionList()
```
  - getKeyCollection
```
public KeyCollection getKeyCollection(int index)
```
  - setKeyMap640
```
public Message setKeyMap640(KeyMap640 keyMap)
```
  - getKeyMap480List
```
public List<KeyMap640> getKeyMap480List()
```
  - getKeyMap640
```
public KeyMap640 getKeyMap640(int index)
```
  - setKeyMapByte
```
public Message setKeyMapByte(KeyMapByte keyMap)
```
  - getKeyMapByteList
```
public List<KeyMapByte> getKeyMapByteList()
```
  - getKeyMapByte
```
public KeyMapByte getKeyMapByte(int index)
```
  - setPublicKey
```
public Message setPublicKey(PublicKey publicKey)
```
  - getPublicKeyList
```
public List<PublicKey> getPublicKeyList()
```
  - getPublicKey
```
public PublicKey getPublicKey(int index)
```
  - setPeerSocketAddresses
```
public Message setPeerSocketAddresses(List<PeerSocketAddress> peerSocketAddresses)
```
  - getPeerSocketAddresses
```
public List<PeerSocketAddress> getPeerSocketAddresses()
```
  - getPublicKey
```
public PublicKey getPublicKey()
```
  - getPrivateKey
```
public PrivateKey getPrivateKey()
```
  - setBuffer
```
public Message setBuffer(Buffer byteBuf)
```
  - getBufferList
```
public List<Buffer> getBufferList()
```
  - getBuffer
```
public Buffer getBuffer(int index)
```
  - setTrackerData
```
public Message setTrackerData(TrackerData trackerData)
```
  - getTrackerDataList
```
public List<TrackerData> getTrackerDataList()
```
  - getTrackerData
```
public TrackerData getTrackerData(int index)
```
  - signatureForVerification
```
public Message signatureForVerification(Signature signature,
                               PublicKey receivedPublicKey)
```
  - signatureForVerification
```
public Signature signatureForVerification()
```
  - receivedSignature
```
public Message receivedSignature(SHA1Signature signatureEncode)
```
  - receivedSignature
```
public SHA1Signature receivedSignature()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - presetContentTypes
```
public Message presetContentTypes(boolean presetContentTypes)
```
    If we are setting values from the decoder, then the content type is already set.
    
    Parameters:
    presetContentTypes - True if the content type is already set.
    
    Returns:
    This class
  - senderSocket
```
public Message senderSocket(InetSocketAddress senderSocket)
```
    Store the sender of the packet. This is needed for UDP traffic.
    
    Parameters:
    senderSocket - The sender as we saw it on the interface
    
    Returns:
    This class
  - senderSocket
```
public InetSocketAddress senderSocket()
```
    Returns:
    The sender of the packet. This is needed for UDP traffic.
  - recipientSocket
```
public Message recipientSocket(InetSocketAddress recipientSocket)
```
    Store the recipient of the packet. This is needed for UDP (especially broadcast) packets
    
    Parameters:
    recipientSocket - The recipient as we saw it on the interface
    
    Returns:
    This class
  - recipientSocket
```
public InetSocketAddress recipientSocket()
```
    Returns:
    The recipient as we saw it on the interface. This is needed for UDP (especially broadcast) packets
  - setHintSign
```
public Message setHintSign()
```
    Set if we have a signed message.
    
    Returns:
    This class
  - isSign
```
public boolean isSign()
```
    Returns:
    True if message is or should be signed
  - udp
```
public Message udp(boolean udp)
```
    Parameters:
    udp - True if connection is UDP
    
    Returns:
    This class
  - isUdp
```
public boolean isUdp()
```
    Returns:
    True if connection is UDP
  - verified
```
public Message verified(boolean verified)
```
  - verified
```
public boolean verified()
```
  - setVerified
```
public Message setVerified()
```
  - done
```
public Message done(boolean done)
```
    Parameters:
    done - True if message decoding or encoding is done
    
    Returns:
    This class
  - setDone
```
public Message setDone()
```
    Set done to true if message decoding or encoding is done.
    
    Returns:
    This class
  - isDone
```
public boolean isDone()
```
    Returns:
    True if message decoding or encoding is done

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_TYPE_LENGTH

Constructor Detail

Message

Method Detail

getMessageId

setMessageId

getVersion

setVersion

getType

setType

getCommand

setCommand

getSender

setSender

getRecipient

setRecipient

getContentTypes

setContentType

restoreContentReferences

setContentType

setContentTypes

contentRefencencs

hasContent

hasContent

isRequest

isFireAndForget

isOk

isNotOk

isError

isError

setOptions

getOptions

setKeepAlive

isKeepAlive

setStreaming

streaming

isStreaming

setKey

getKeyList

getKey

setBloomFilter

getBloomFilterList

getBloomFilter

setPublicKeyAndSign

setInteger

getIntegerList

getInteger

setLong

getLongList

getLong

setNeighborsSet

getNeighborsSetList

getNeighborsSet

setDataMap

getDataMapList

getDataMap

setKeyCollection

getKeyCollectionList

getKeyCollection

setKeyMap640

getKeyMap480List

getKeyMap640

setKeyMapByte

getKeyMapByteList

getKeyMapByte

setPublicKey

getPublicKeyList

getPublicKey

setPeerSocketAddresses

getPeerSocketAddresses

getPublicKey

getPrivateKey

setBuffer