Message (TomP2P Core 5.0-Beta1 API)

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

```
public class Message
extends Object
```
The message is in binary format in TomP2P. It has several header and payload fields. Since we do the serialization/encoding 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
`SimpleBloomFilter<Number160>`	`bloomFilter(int index)`
`Message`	`bloomFilter(SimpleBloomFilter<Number160> bloomFilter)`
`List<SimpleBloomFilter<Number160>>`	`bloomFilterList()`
`Message`	`buffer(Buffer byteBuf)`
`Buffer`	`buffer(int index)`
`List<Buffer>`	`bufferList()`
`byte`	`command()` Command of the message, such as GET, PING, etc.
`Message`	`command(byte command)` Command of the message, such as GET, PING, etc.
`Queue<MessageContentIndex>`	`contentReferences()`
`Message`	`contentType(int index, Message.Content contentType)` Sets or replaces the content type at a specific index.
`Message`	`contentType(Message.Content contentType)` Convenient method to set content type.
`Message.Content[]`	`contentTypes()` Return content types.
`Message`	`contentTypes(Message.Content[] contentTypes)` Used for deserialization.
`DataMap`	`dataMap(int index)`
`List<DataMap>`	`dataMapList()`
`boolean`	`hasContent()`
`Message`	`hasContent(boolean content)`
`Integer`	`intAt(int index)`
`List<Integer>`	`intList()`
`Message`	`intValue(int integer)`
`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`	`keepAlive(boolean isKeepAlive)`
`Number160`	`key(int index)`
`Message`	`key(Number160 key)`
`KeyCollection`	`keyCollection(int index)`
`Message`	`keyCollection(KeyCollection key)`
`List<KeyCollection>`	`keyCollectionList()`
`List<Number160>`	`keyList()`
`KeyMap640Keys`	`keyMap640Keys(int index)`
`Message`	`keyMap640Keys(KeyMap640Keys keyMap)`
`List<KeyMap640Keys>`	`keyMap640KeysList()`
`KeyMapByte`	`keyMapByte(int index)`
`Message`	`keyMapByte(KeyMapByte keyMap)`
`List<KeyMapByte>`	`keyMapByteList()`
`Long`	`longAt(int index)`
`List<Long>`	`longList()`
`Message`	`longValue(long long0)`
`int`	`messageId()` Randomly generated message ID.
`Message`	`messageId(int messageId)` For deserialization, we need to set the id.
`NeighborSet`	`neighborsSet(int index)`
`Message`	`neighborsSet(NeighborSet neighborSet)`
`List<NeighborSet>`	`neighborsSetList()`
`int`	`options()`
`Message`	`options(int options)`
`List<PeerSocketAddress>`	`peerSocketAddresses()`
`Message`	`peerSocketAddresses(Collection<PeerSocketAddress> peerSocketAddresses)`
`Message`	`presetContentTypes(boolean presetContentTypes)` If we are setting values from the decoder, then the content type is already set.
`PrivateKey`	`privateKey()`
`PublicKey`	`publicKey(int index)`
`Message`	`publicKey(PublicKey publicKey)`
`Message`	`publicKeyAndSign(KeyPair keyPair)`
`List<PublicKey>`	`publicKeyList()`
`SignatureCodec`	`receivedSignature()`
`Message`	`receivedSignature(SignatureCodec signatureEncode)`
`PeerAddress`	`recipient()` The ID of the recipient.
`Message`	`recipient(PeerAddress recipient)` Set the ID of the recipient.
`PeerAddress`	`recipientRelay()`
`Message`	`recipientRelay(PeerAddress recipientRelay)`
`InetSocketAddress`	`recipientSocket()`
`Message`	`recipientSocket(InetSocketAddress recipientSocket)` Store the recipient of the packet.
`void`	`restoreBuffers()` Restores all buffers such that they can be re-read (e.g.
`void`	`restoreContentReferences()` Restore the content references if only the content types array is present.
`PeerAddress`	`sender()` The ID of the sender.
`Message`	`sender(PeerAddress sender)` The ID of the sender.
`InetSocketAddress`	`senderSocket()`
`Message`	`senderSocket(InetSocketAddress senderSocket)` Store the sender of the packet.
`Message`	`setDataMap(DataMap dataMap)`
`Message`	`setDone()` Set done to true if message decoding or encoding is done.
`Message`	`setDone(boolean done)`
`Message`	`setHintSign()` Set if we have a signed message.
`Message`	`setVerified()`
`Message`	`streaming()`
`Message`	`streaming(boolean streaming)`
`String`	`toString()`
`TrackerData`	`trackerData(int index)`
`Message`	`trackerData(TrackerData trackerData)`
`List<TrackerData>`	`trackerDataList()`
`Message.Type`	`type()` Determines if its a request or command reply, and what kind of reply (error, warning states).
`Message`	`type(Message.Type type)` Set the message type.
`Message`	`udp(boolean udp)`
`boolean`	`verified()`
`Message`	`verified(boolean verified)`
`int`	`version()` Returns the version, which is 32bit.
`Message`	`version(int version)` For deserialization.

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
  - messageId
```
public int messageId()
```
    Randomly generated message ID.
    
    Returns:
    message Id
  - messageId
```
public Message messageId(int messageId)
```
    For deserialization, we need to set the id.
    
    Parameters:
    messageId - The message Id
    
    Returns:
    This class
  - version
```
public int version()
```
    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
  - version
```
public Message version(int version)
```
    For deserialization.
    
    Parameters:
    version - The 24bit version
    
    Returns:
    This class
  - type
```
public Message.Type type()
```
    Determines if its a request or command reply, and what kind of reply (error, warning states).
    
    Returns:
    Type of the message
  - type
```
public Message type(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
  - command
```
public byte command()
```
    Command of the message, such as GET, PING, etc.
    
    Returns:
    Command
  - command
```
public Message command(byte command)
```
    Command of the message, such as GET, PING, etc.
    
    Parameters:
    command - Command
    
    Returns:
    This class
  - sender
```
public PeerAddress sender()
```
    The ID of the sender. Note that the IP is set via the socket.
    
    Returns:
    The ID of the sender.
  - sender
```
public Message sender(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
  - recipient
```
public PeerAddress recipient()
```
    The ID of the recipient. Note that the IP is set via the socket.
    
    Returns:
    The ID of the recipient
  - recipient
```
public Message recipient(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
  - recipientRelay
```
public PeerAddress recipientRelay()
```
  - recipientRelay
```
public Message recipientRelay(PeerAddress recipientRelay)
```
  - contentTypes
```
public Message.Content[] contentTypes()
```
    Return content types. Content type can be empty if not set
    
    Returns:
    Content type 1
  - contentType
```
public Message contentType(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 decoding 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.
  - restoreBuffers
```
public void restoreBuffers()
```
    Restores all buffers such that they can be re-read (e.g. used for encoding). If the message does not have any buffer, this method does nothing.
  - contentType
```
public Message contentType(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
  - contentTypes
```
public Message contentTypes(Message.Content[] contentTypes)
```
    Used for deserialization.
    
    Parameters:
    contentTypes - The content types that were decoded.
    
    Returns:
    This class
  - contentReferences
```
public Queue<MessageContentIndex> contentReferences()
```
    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
  - options
```
public Message options(int options)
```
    Parameters:
    options - The option from the last byte of the header
    
    Returns:
    This class
  - options
```
public int options()
```
    Returns:
    The options from the last byte of the header
  - keepAlive
```
public Message keepAlive(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
  - streaming
```
public Message streaming()
```
  - streaming
```
public Message streaming(boolean streaming)
```
  - isStreaming
```
public boolean isStreaming()
```
  - key
```
public Message key(Number160 key)
```
  - keyList
```
public List<Number160> keyList()
```
  - key
```
public Number160 key(int index)
```
  - bloomFilter
```
public Message bloomFilter(SimpleBloomFilter<Number160> bloomFilter)
```
  - bloomFilterList
```
public List<SimpleBloomFilter<Number160>> bloomFilterList()
```
  - bloomFilter
```
public SimpleBloomFilter<Number160> bloomFilter(int index)
```
  - publicKeyAndSign
```
public Message publicKeyAndSign(KeyPair keyPair)
```
  - intValue
```
public Message intValue(int integer)
```
  - intList
```
public List<Integer> intList()
```
  - intAt
```
public Integer intAt(int index)
```
  - longValue
```
public Message longValue(long long0)
```
  - longList
```
public List<Long> longList()
```
  - longAt
```
public Long longAt(int index)
```
  - neighborsSet
```
public Message neighborsSet(NeighborSet neighborSet)
```
  - neighborsSetList
```
public List<NeighborSet> neighborsSetList()
```
  - neighborsSet
```
public NeighborSet neighborsSet(int index)
```
  - setDataMap
```
public Message setDataMap(DataMap dataMap)
```
  - dataMapList
```
public List<DataMap> dataMapList()
```
  - dataMap
```
public DataMap dataMap(int index)
```
  - keyCollection
```
public Message keyCollection(KeyCollection key)
```
  - keyCollectionList
```
public List<KeyCollection> keyCollectionList()
```
  - keyCollection
```
public KeyCollection keyCollection(int index)
```
  - keyMap640Keys
```
public Message keyMap640Keys(KeyMap640Keys keyMap)
```
  - keyMap640KeysList
```
public List<KeyMap640Keys> keyMap640KeysList()
```
  - keyMap640Keys
```
public KeyMap640Keys keyMap640Keys(int index)
```
  - keyMapByte
```
public Message keyMapByte(KeyMapByte keyMap)
```
  - keyMapByteList
```
public List<KeyMapByte> keyMapByteList()
```
  - keyMapByte
```
public KeyMapByte keyMapByte(int index)
```
  - publicKey
```
public Message publicKey(PublicKey publicKey)
```
  - publicKeyList
```
public List<PublicKey> publicKeyList()
```
  - publicKey
```
public PublicKey publicKey(int index)
```
  - peerSocketAddresses
```
public Message peerSocketAddresses(Collection<PeerSocketAddress> peerSocketAddresses)
```
  - peerSocketAddresses
```
public List<PeerSocketAddress> peerSocketAddresses()
```
  - privateKey
```
public PrivateKey privateKey()
```
  - buffer
```
public Message buffer(Buffer byteBuf)
```
  - bufferList
```
public List<Buffer> bufferList()
```
  - buffer
```
public Buffer buffer(int index)
```
  - trackerData
```
public Message trackerData(TrackerData trackerData)
```
  - trackerDataList
```
public List<TrackerData> trackerDataList()
```
  - trackerData
```
public TrackerData trackerData(int index)
```
  - receivedSignature
```
public Message receivedSignature(SignatureCodec signatureEncode)
```
  - receivedSignature
```
public SignatureCodec 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()
```
  - setDone
```
public Message setDone(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

messageId

messageId

version

version

type

type

command

command

sender

sender

recipient

recipient

recipientRelay

recipientRelay

contentTypes

contentType

restoreContentReferences

restoreBuffers

contentType

contentTypes

contentReferences

hasContent

hasContent

isRequest

isFireAndForget

isOk

isNotOk

isError

isError

options

options

keepAlive

isKeepAlive

streaming

streaming

isStreaming

key

keyList

key

bloomFilter

bloomFilterList

bloomFilter

publicKeyAndSign

intValue

intList

intAt

longValue

longList

longAt

neighborsSet

neighborsSetList

neighborsSet

setDataMap

dataMapList

dataMap

keyCollection

keyCollectionList

keyCollection

keyMap640Keys

keyMap640KeysList

keyMap640Keys

keyMapByte

keyMapByteList

keyMapByte

publicKey

publicKeyList

publicKey

peerSocketAddresses

peerSocketAddresses