lmsg::MsgHeader Class Reference
[DMT message facility]

#include <MsgHeader.hh>

List of all members.

Public Types
typedef count_t	MsgType
Public Member Functions
	~MsgHeader (void)
	MsgHeader (void)
	MsgHeader (count_t type, count_t length, const MsgAddr &dest)
const MsgAddr &	getDest (void) const
const MsgAddr &	getSource (void) const
MsgAddr &	getDest (void)
MsgAddr &	getSource (void)
MsgType	getMsgType (void) const
count_t	getMsgLength (void) const
count_t	getBlockID (void) const
count_t	getTransID (void) const
void	Dump (std::ostream &out) const
void	Import (void)
void	Export (void)
void	setDest (const MsgAddr &addr)
void	setSource (const MsgAddr &addr)
void	setMsgType (MsgType type)
void	setMsgLength (count_t length)
void	setBlockID (count_t id)
void	setTransID (count_t id)

---

Detailed Description

The message header contains the message type and routing information. brief Message header class.

Author:

J. Zweizig

Version:

1.1; Modified 2/1/2000

---

Member Typedef Documentation

typedef count_t lmsg::MsgHeader::MsgType

Data type used to hold message type code.

---

Constructor & Destructor Documentation

lmsg::MsgHeader::~MsgHeader

(

void

)

Message header destructor. brief Destructor.

lmsg::MsgHeader::MsgHeader

(

void

)

Construct an empty message header. brief Empty header constructor.

lmsg::MsgHeader::MsgHeader	(	count_t	type,
		count_t	length,
		const MsgAddr &	dest
	)

Construct a message header with the specified type, length and destination. brief Full constructor.

---

Member Function Documentation

const lmsg::MsgAddr & lmsg::MsgHeader::getDest

(

void

)

const [inline]

The destination field of the message header is returned. brief get the destination address.

Returns:

The destination address.

const lmsg::MsgAddr & lmsg::MsgHeader::getSource

(

void

)

const [inline]

The source field of the message header is returned. brief Get the source address.

Returns:

The source address.

lmsg::MsgAddr & lmsg::MsgHeader::getDest

(

void

)

[inline]

A mutable reference to the destination address of the message header is returned. brief Get a reference to the destination address.

Returns:

A mutable reference to the destination address.

lmsg::MsgAddr & lmsg::MsgHeader::getSource

(

void

)

[inline]

A mutable reference to the source address of the message header is returned. brief Get a reference to the source address.

Returns:

A mutable reference to the source address.

lmsg::MsgHeader::MsgType lmsg::MsgHeader::getMsgType

(

void

)

const [inline]

The type field is returned from the message header. brief Get the message type.

Returns:

The message type.

lmsg::MsgHeader::count_t lmsg::MsgHeader::getMsgLength

(

void

)

const [inline]

The message data length field is returned from the header. brief Get the message data length.

Returns:

The message data length.

lmsg::MsgHeader::count_t lmsg::MsgHeader::getBlockID

(

void

)

const [inline]

The block ID field is returned from the message header. brief Get the block ID.

Returns:

The message Block ID.

lmsg::MsgHeader::count_t lmsg::MsgHeader::getTransID

(

void

)

const [inline]

The transaction identifier field is returned from the message header. brief Get the message transaction ID.

Returns:

The transaction identifier.

void lmsg::MsgHeader::Dump

(

std::ostream &

out

)

const

Dump the contents of the message header to an output stream. brief Dump the header.

Parameters:

out

Stream to which the header is dumped.

void lmsg::MsgHeader::Import

(

void

)

Translate the header contents from external (big endian) format to the local format. brief Convert to internal format.

void lmsg::MsgHeader::Export

(

void

)

Translate the header contents from the local format to the external (big endian) format. brief Convert to external format.

void lmsg::MsgHeader::setDest

(

const MsgAddr &

addr

)

Set the message header destination address. brief Set the destination address.

Parameters:

addr

Address to which the destination field will be set.

void lmsg::MsgHeader::setSource

(

const MsgAddr &

addr

)

Set the message header source address. brief Set the source address.

Parameters:

addr

Address to which the message source field will be set.

void lmsg::MsgHeader::setMsgType

(

MsgType

type

)

Set the message type field. brief Set the type.

void lmsg::MsgHeader::setMsgLength

(

count_t

length

)

Set the message data length field. brief Set the data length.

void lmsg::MsgHeader::setBlockID

(

count_t

id

)

Set the message block identifier field. brief Set the block ID.

void lmsg::MsgHeader::setTransID

(

count_t

id

)

Set the transaction identifier field. brief Set the transaction ID.

---

The documentation for this class was generated from the following file:

• lmsg/MsgHeader.hh

---