Messager Class Reference
[Communications Facilities]

#include <Messager.hh>

Inherited by Mailer, and StreamSource.

List of all members.

---

Detailed Description

Superclass for both Mailer and StreamSource classes.

This is a superclass for both Mailer and StreamSource. Both of these are structurally very similar and the common functionality related to message sending is captured within this class's interface.

Public Member Functions
	Messager (CommManager *mgr, RemoteManager *dest, int max_size, com_id_t id, com_id_t exclusive_dest=0, MessagePool *pool=NULL)
Message *	createMsg ()
RemoteManager *	getDest () const
com_id_t	getID () const
int	getMaxSize () const
bool	valid () const
void	invalidate ()
bool	check_dest ()
CommManager *	getManager () const
void	releaseMsg (Message *m)
com_id_t	getExclusiveID () const
void	setMaxSize (int new_max_size)

---

Member Function Documentation

Message* Messager::createMsg (   )  [inline]

This method creates a message to be sent. It will be set with the maximum capacity of the mailbox as specified by CommManager::createMailer or CommManager::createStreamSource.

RemoteManager* Messager::getDest (   )  const [inline]

This method returns the reference to the communication manager which handles the destination mailbox.

com_id_t Messager::getID (   )  const [inline]

This method returns the mailbox ID.

int Messager::getMaxSize (   )  const [inline]

This method returns the maximum capacity of the mailbox.

void Messager::releaseMsg (  Message *  m  )  [inline]

If you create a message but do not send it, or sendMessage returns -1, then you must use this method to release the message.

---

RHexLib Reference Documentation