net.sf.jrtps.message

Class Message

java.lang.Object

net.sf.jrtps.message.Message

public class Message
extends Object

This class represents a RTPS message.

Author:

mcr70

Constructor Summary

Constructors

Constructor and Description
Message(GuidPrefix prefix) Constructor.
Message(Header header) Constructor.
Message(RTPSByteBuffer bb) Constructs a Message from given RTPSByteBuffer.

Method Summary

Modifier and Type	Method and Description
void	addSubMessage(SubMessage sm) Adds a new SubMessage to this Message.
Header	getHeader() Gets the Header of this Message.
List<SubMessage>	getSubMessages() Gets all the SubMessages of this Message.
String	toString()
boolean	writeTo(RTPSByteBuffer buffer) Writes this Message to given RTPSByteBuffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(GuidPrefix prefix)

Constructor.

Parameters:

prefix - GuidPrefix

Message

public Message(Header header)

Constructor.

Parameters:

header - Header

Message

public Message(RTPSByteBuffer bb)
        throws IllegalMessageException

Constructs a Message from given RTPSByteBuffer.

Parameters:

bb - Reads Message from this RTPSByteBuffer

Throws:

IllegalMessageException - If message could not be parsed

Method Detail

getHeader

public Header getHeader()

Gets the Header of this Message.

Returns:

Header

getSubMessages

public List<SubMessage> getSubMessages()

Gets all the SubMessages of this Message.

Returns:

List of SubMessages. Returned List is never null.

writeTo

public boolean writeTo(RTPSByteBuffer buffer)

Writes this Message to given RTPSByteBuffer. During writing of each SubMessage, its length is calculated and SubMessageHeader.submessageLength is updated. If an overflow occurs during writing, buffer position is set to the start of submessage that caused overflow.

Parameters:

buffer - RTPSByteBuffer to write to

Returns:

true, if an overflow occured during write.

addSubMessage

public void addSubMessage(SubMessage sm)

Adds a new SubMessage to this Message. SubMessage must well formed.

Parameters:

sm - SubMessage to add

toString

public String toString()

Overrides:

toString in class Object