iso::com::MessageParser Class Reference

#include <iso_com_message_parser.h>

Inherited by iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

Inheritance diagram for iso::com::MessageParser:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 MessageParser ()
virtual ~MessageParser ()
virtual unsigned int messageBufferSize (const Message &pMessage) const =0 throw (ComException)
 calculate message buffer size
virtual bool checkMessage (const Message &pMessage) const =0
 check if message conforms to expected message format
virtual void message2buffer (const Message &pMessage, ByteBuffer &pMessageBuffer) const =0 throw (ComException)
 convert message into message buffer
virtual void buffer2message (const ByteBuffer &pMessageBuffer, Message &pMessage) const =0 throw (ComException)
 convert message buffer into message
virtual void buffer2packets (const ByteBuffer &pMessageBuffer, QVector< ByteBuffer * > &pPackets, unsigned int pMaxPacketSize) const =0 throw (ComException)
 convert message buffer into data packets
virtual bool match (ByteBuffer &pPacketBuffer, PendingByteBuffer &pMessageBuffer) const =0 throw (ComException)
 check if packet buffer contains data for message buffer
virtual void packet2buffer (const ByteBuffer &pPacketBuffer, PendingByteBuffer &pMessageBuffer) const =0 throw (ComException)
 convert data packet into message buffer
virtual base::String messageInfo (const Message &pMessage) const =0 throw (ComException)
 convert message info into string
virtual base::String packetInfo (const ByteBuffer &pPacketBuffer) const =0 throw (ComException)
 retrieve textual information about data packet

Constructor & Destructor Documentation

MessageParser::MessageParser (  ) 

MessageParser::~MessageParser (  )  [virtual]


Member Function Documentation

virtual unsigned int iso::com::MessageParser::messageBufferSize ( const Message pMessage  )  const throw (ComException) [pure virtual]

calculate message buffer size

Parameters:
pMessage message
Returns:
message buffer size (number of bytes)
Exceptions:
ComException message doesn't conform to expected message format

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual bool iso::com::MessageParser::checkMessage ( const Message pMessage  )  const [pure virtual]

check if message conforms to expected message format

Parameters:
pMessage message
Returns:
true if message format is correct, false otherwise

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual void iso::com::MessageParser::message2buffer ( const Message pMessage,
ByteBuffer pMessageBuffer 
) const throw (ComException) [pure virtual]

convert message into message buffer

Parameters:
pMessage message
pMessageBuffer message buffer
Exceptions:
ComException message doesn't conform to expected message format
Remarks:
message buffer array must have been correctly allocated beforehand

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual void iso::com::MessageParser::buffer2message ( const ByteBuffer pMessageBuffer,
Message pMessage 
) const throw (ComException) [pure virtual]

convert message buffer into message

Parameters:
pMessageBuffer message buffer
pMessage message
Exceptions:
ComException message doesn't conform to expected message format

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual void iso::com::MessageParser::buffer2packets ( const ByteBuffer pMessageBuffer,
QVector< ByteBuffer * > &  pPackets,
unsigned int  pMaxPacketSize 
) const throw (ComException) [pure virtual]

convert message buffer into data packets

Parameters:
pMessageBufferPos position of packet within message buffer
pPacketBuffer message buffer
pPackets vector of data packets
pMaxPacketSize maximum packet size (in bytes)

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual bool iso::com::MessageParser::match ( ByteBuffer pPacketBuffer,
PendingByteBuffer pMessageBuffer 
) const throw (ComException) [pure virtual]

check if packet buffer contains data for message buffer

Returns:
true if yes, false otherwise

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual void iso::com::MessageParser::packet2buffer ( const ByteBuffer pPacketBuffer,
PendingByteBuffer pMessageBuffer 
) const throw (ComException) [pure virtual]

convert data packet into message buffer

Parameters:
pPacketBuffer data packet
pMessageBuffer message buffer

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual base::String iso::com::MessageParser::messageInfo ( const Message pMessage  )  const throw (ComException) [pure virtual]

convert message info into string

Parameters:
pMessage message
Returns:
string containing textual message information
Exceptions:
ComException message doesn't conform to expected message format

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.

virtual base::String iso::com::MessageParser::packetInfo ( const ByteBuffer pPacketBuffer  )  const throw (ComException) [pure virtual]

retrieve textual information about data packet

Parameters:
pPacketBuffer data packet buffer

Implemented in iso::com::DefaultMessageParser, and iso::com::OSCMessageParser.


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 13:53:12 2011 for iso_com by  doxygen 1.5.1