lmsg::Message Class Reference
[DMT message facility]

#include <Message.hh>

Inheritance diagram for lmsg::Message:

lmsg::DataMsg< T, MsgID > lmsg::HdrOnlyMsg< MsgID >

List of all members.

Public Member Functions

 Message (void)
virtual ~Message (void)
virtual size_type size (void) const =0
virtual void getData (TransOutput &out) const =0
virtual MsgHeader::MsgType getType (void) const =0
virtual void setData (TransInput &in)=0 throw (std::runtime_error)


Detailed Description

Message defines the APi for a data message passed over the Ligo Message Interface. brief Message API.
Author:
John Zweizig
Version:
1.1; Modified March 30, 2000

Constructor & Destructor Documentation

lmsg::Message::Message ( void   )  [inline]

Null default constructor.

virtual lmsg::Message::~Message ( void   )  [inline, virtual]

Null default destructor.


Member Function Documentation

virtual size_type lmsg::Message::size ( void   )  const [pure virtual]

Get the length of the message. brief Get message length.

Implemented in lmsg::DataMsg< T, MsgID >, and lmsg::HdrOnlyMsg< MsgID >.

virtual void lmsg::Message::getData ( TransOutput out  )  const [pure virtual]

Copy data from the message to an lmsg::TransOutput stream. brief Serialize the message.

Parameters:
out Stream to which the message data are copied.

Implemented in lmsg::DataMsg< T, MsgID >, and lmsg::HdrOnlyMsg< MsgID >.

virtual MsgHeader::MsgType lmsg::Message::getType ( void   )  const [pure virtual]

Function to poll the message type. brief Message type.

Returns:
Type code of the message.

Implemented in lmsg::DataMsg< T, MsgID >, and lmsg::HdrOnlyMsg< MsgID >.

virtual void lmsg::Message::setData ( TransInput in  )  throw (std::runtime_error) [pure virtual]

Copy data from an lmsg::TransOutput stream into the message. brief Deserialize the message.

Parameters:
in Stream from which the message data are copied.

Implemented in lmsg::DataMsg< T, MsgID >, and lmsg::HdrOnlyMsg< MsgID >.


The documentation for this class was generated from the following file:
Generated on Sun Mar 8 19:21:33 2009 for dmt by  doxygen 1.5.4