BlaubotMessage (Blaubot JavaDoc)

java.lang.Object
- eu.hgross.blaubot.messaging.BlaubotMessage

public class BlaubotMessage
extends java.lang.Object

The message object that is sent through connections

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BlaubotMessage.Priority
Priority for BlaubotMessages.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BlaubotMessage.Priority` Priority for BlaubotMessages.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHANNEL_FIELD_LENGTH`
`static int`	`CHUNK_ID_FIELD_LENGTH`
`static int`	`CHUNK_NO_FIELD_LENGTH`
`static int`	`FULL_HEADER_LENGTH`
`static int`	`PAYLOAD_LENGTH_FIELD_LENGTH`
`static int`	`PRIORITY_FIELD_LENGTH`
`protected int`	`sequenceNumber` An attribute that is not sent via the connection Only used to send messages with the same priority in the order they were queued.
`static int`	`TYPE_FIELD_LENGTH`
`static int`	`VERSION_FIELD_LENGTH`

Constructor Summary

Constructors
Constructor and Description

BlaubotMessage()
Constructs a default message, which sends data on a default channel

Constructors
Constructor and Description
`BlaubotMessage()` Constructs a default message, which sends data on a default channel

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`applyBytes(byte[] headerBytes)` Applies all data from the message schema except the payload, which has to be set afterwards by setPayload(), to this instance.
`protected static int`	`calculateHeaderLength(BlaubotMessageType messageType)` Calculates a messages total header length by a given BlaubotMessageType
`java.util.List<BlaubotMessage>`	`createChunks(short chunkId)` Creates chunks of this message containing the given chunkId.
`boolean`	`equals(java.lang.Object o)`
`static BlaubotMessage`	`fromByteArray(byte[] messageBytes)` Deserializes a BlaubotMessage from a byte array.
`static BlaubotMessage`	`fromChunks(java.util.List<BlaubotMessage> chunks)` Creates a message from multiple chunks
`short`	`getChannelId()` Retrieves the channelId for which this message was designated.
`short`	`getChunkId()` If this message is a chunk message, gets the chunk id.
`short`	`getChunkNo()` If this message is a chunk message, returns the chunk number.
`protected IBlaubotConnection`	`getLastOriginatorConnection()` Gets the last originators connection.
`BlaubotMessageType`	`getMessageType()`
`byte[]`	`getPayload()` Retrieve this message's payload
`BlaubotMessage.Priority`	`getPriority()`
`byte`	`getProtocolVersion()`
`int`	`hashCode()`
`static void`	`main(java.lang.String[] args)`
`static BlaubotMessage`	`readFromBlaubotConnection(IBlaubotConnection connection)` Reads a message from a given connection (readFully)
`static BlaubotMessage`	`readFromBlaubotConnection(IBlaubotConnection blaubotConnection, java.nio.ByteBuffer headerByteBuffer, byte[] headerBuffer)` Reads a message from a given connection and reuses buffers
`protected void`	`setChannelId(short channelId)`
`void`	`setChunkId(short chunkId)` sets the chunk id
`void`	`setChunkNo(short chunkNo)` Sets the chunk number
`protected void`	`setLastOriginatorConnection(IBlaubotConnection originatorConnection)`
`protected void`	`setMessageType(BlaubotMessageType messageType)`
`void`	`setPayload(byte[] payload)` Set the payload of this message.
`void`	`setPriority(BlaubotMessage.Priority priority)`
`protected void`	`setProtocolVersion(byte protocolVersion)`
`byte[]`	`toBytes()` Serializes the message to a byte array.
`java.lang.String`	`toString()`

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

- Field Detail
  - VERSION_FIELD_LENGTH
```
public static final int VERSION_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - TYPE_FIELD_LENGTH
```
public static final int TYPE_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - PRIORITY_FIELD_LENGTH
```
public static final int PRIORITY_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - CHANNEL_FIELD_LENGTH
```
public static final int CHANNEL_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - PAYLOAD_LENGTH_FIELD_LENGTH
```
public static final int PAYLOAD_LENGTH_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - CHUNK_ID_FIELD_LENGTH
```
public static final int CHUNK_ID_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - CHUNK_NO_FIELD_LENGTH
```
public static final int CHUNK_NO_FIELD_LENGTH
```
    See Also:
    
    Constant Field Values
  - FULL_HEADER_LENGTH
```
public static final int FULL_HEADER_LENGTH
```
    See Also:
    
    Constant Field Values
  - sequenceNumber
```
protected int sequenceNumber
```
    An attribute that is not sent via the connection Only used to send messages with the same priority in the order they were queued.
- Constructor Detail
  - BlaubotMessage
```
public BlaubotMessage()
```
    Constructs a default message, which sends data on a default channel
- Method Detail
  - createChunks
```
public java.util.List<BlaubotMessage> createChunks(short chunkId)
```
    Creates chunks of this message containing the given chunkId. The chunk messages are numbered. The numbers can be retrieved via #getChunkNumber(). To signal a potential receiver that a chunk message is the last message of a chunkId, a chunk message with less than BlaubotConstants.MAX_PAYLOAD_SIZE payload size is send. If the last message's payload is equal to BlaubotConstants.MAX_PAYLOAD_SIZE the last message will not contain any payload.
    
    Parameters:
    
    chunkId - the chunk id to identify this message
    
    Returns:
    
    the ordered list of chunks
    
    Throws:
    
    java.lang.IllegalArgumentException - iff the message contains too much payload to chunk (more than Short.MAX_VALUE resulting chunks)
  - fromChunks
```
public static BlaubotMessage fromChunks(java.util.List<BlaubotMessage> chunks)
```
    Creates a message from multiple chunks
    
    Parameters:
    
    chunks - the complete list of chunks with the same chunkId. Must not be ordered.
    
    Returns:
    
    the message
  - getLastOriginatorConnection
```
protected IBlaubotConnection getLastOriginatorConnection()
```
    Gets the last originators connection. This is the connection over which this message was received. Note that this only represents the origin of the message's last hop and NOT the connection from the original sender.
    
    Returns:
    
    the originator connection or null, if not received from a connection
  - setLastOriginatorConnection
```
protected void setLastOriginatorConnection(IBlaubotConnection originatorConnection)
```
  - getProtocolVersion
```
public byte getProtocolVersion()
```
  - setProtocolVersion
```
protected void setProtocolVersion(byte protocolVersion)
```
  - getMessageType
```
public BlaubotMessageType getMessageType()
```
  - setMessageType
```
protected void setMessageType(BlaubotMessageType messageType)
```
  - getPriority
```
public BlaubotMessage.Priority getPriority()
```
  - setPriority
```
public void setPriority(BlaubotMessage.Priority priority)
```
  - getChannelId
```
public short getChannelId()
```
    Retrieves the channelId for which this message was designated. There are some cases in which no channel is involved like: - AdminMessages - KeepAliveMessages for which this method will return -1;
    
    Returns:
    
    channelId or -1, if no channel is involved
  - setChannelId
```
protected void setChannelId(short channelId)
```
  - getPayload
```
public byte[] getPayload()
```
    Retrieve this message's payload
    
    Returns:
    
    payload as byte array (max 65535 bytes)
  - setPayload
```
public void setPayload(byte[] payload)
```
    Set the payload of this message.
    
    Parameters:
    
    payload - the payload bytes
    
    Throws:
    
    java.lang.IllegalArgumentException - if the payload length exeeds 65535 bytes
  - applyBytes
```
public int applyBytes(byte[] headerBytes)
```
    Applies all data from the message schema except the payload, which has to be set afterwards by setPayload(), to this instance. The payload's length is returned.
    
    Parameters:
    
    headerBytes - the byte array containing all header informations
    
    Returns:
    
    the payloads length in bytes - 0 if no payload at all.
  - calculateHeaderLength
```
protected static int calculateHeaderLength(BlaubotMessageType messageType)
```
    Calculates a messages total header length by a given BlaubotMessageType
    
    Parameters:
    
    messageType - the message type
    
    Returns:
    
    the length of all header fields excluding the payload bytes.
  - toBytes
```
public byte[] toBytes()
```
    Serializes the message to a byte array. The resulting bytes contain the header as well as the payload (if any).
    
    Returns:
    
    byte array containing the message's header as well as payload (if any)
  - fromByteArray
```
public static BlaubotMessage fromByteArray(byte[] messageBytes)
```
    Deserializes a BlaubotMessage from a byte array. The byte array should contain the header and payload.
    
    Parameters:
    
    messageBytes - byte array containing header and payload
    
    Returns:
    
    the deserialized blaubot message
  - getChunkNo
```
public short getChunkNo()
```
    If this message is a chunk message, returns the chunk number.
    
    Returns:
    
    the chunk number
  - setChunkNo
```
public void setChunkNo(short chunkNo)
```
    Sets the chunk number
    
    Parameters:
    
    chunkNo - has to be 1-based
  - getChunkId
```
public short getChunkId()
```
    If this message is a chunk message, gets the chunk id.
    
    Returns:
    
    the chunk id
  - setChunkId
```
public void setChunkId(short chunkId)
```
    sets the chunk id
    
    Parameters:
    
    chunkId - the chunk id
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - readFromBlaubotConnection
```
public static BlaubotMessage readFromBlaubotConnection(IBlaubotConnection connection)
                                                throws java.io.IOException
```
    Reads a message from a given connection (readFully)
    
    Parameters:
    
    connection - the connection
    
    Returns:
    
    the message
    
    Throws:
    
    java.io.IOException - if something goes wrong
  - readFromBlaubotConnection
```
public static BlaubotMessage readFromBlaubotConnection(IBlaubotConnection blaubotConnection,
                                                       java.nio.ByteBuffer headerByteBuffer,
                                                       byte[] headerBuffer)
                                                throws java.io.IOException
```
    Reads a message from a given connection and reuses buffers
    
    Parameters:
    
    blaubotConnection - the connection
    
    headerByteBuffer - the byte buffer around header buffer
    
    headerBuffer - the header buffer
    
    Returns:
    
    the message
    
    Throws:
    
    java.io.IOException - if something goes wrong
  - main
```
public static void main(java.lang.String[] args)
```

Class BlaubotMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION_FIELD_LENGTH

TYPE_FIELD_LENGTH

PRIORITY_FIELD_LENGTH

CHANNEL_FIELD_LENGTH

PAYLOAD_LENGTH_FIELD_LENGTH

CHUNK_ID_FIELD_LENGTH

CHUNK_NO_FIELD_LENGTH

FULL_HEADER_LENGTH

sequenceNumber

Constructor Detail

BlaubotMessage

Method Detail

createChunks

fromChunks

getLastOriginatorConnection

setLastOriginatorConnection

getProtocolVersion

setProtocolVersion

getMessageType

setMessageType

getPriority

setPriority

getChannelId

setChannelId

getPayload

setPayload

applyBytes

calculateHeaderLength

toBytes

fromByteArray

getChunkNo

setChunkNo

getChunkId

setChunkId

equals

hashCode

toString

readFromBlaubotConnection

readFromBlaubotConnection

main