RemoteManager Class Reference
[Communications Facilities]

#include <RemoteManager.hh>

Inherited by NetRemoteManager, and SerialRemoteManager.

List of all members.

---

Detailed Description

Class to keep track of a remote communications manager.

This class contains all the information a communication manager has about a remote communications manager and provides an abstracted method for sending messages.

Public Member Functions
virtual	~RemoteManager ()
com_id_t	getID () const
void	setID (com_id_t id)
TimeStamp	getTimeStamp () const
void	setTimeStamp (TimeStamp t)
int	lastContactTime ()
virtual bool	sendMsg (Message *msg, unsigned char *preamble=NULL, int preamble_size=0)=0
Static Public Member Functions
utils::Generator< RemoteManager > *	generator (utils::SymbolTable *table)
RemoteManager *	generate (const char *spec_string, utils::SymbolTable *table)

---

Constructor & Destructor Documentation

virtual RemoteManager::~RemoteManager (   )  [inline, virtual]

Empty virtual destructor for C++ syntactic reasons

---

Member Function Documentation

RemoteManager* RemoteManager::generate (  const char *  spec_string, utils::SymbolTable *  table )  [static]

Create a remote manager given a spec string and a symbol table Parameters: [in]  spec_string The specification string [in]  table The symbol table Returns: Returns the remote manager generated from the specificaiton string, or NULL if there was an error.

utils::Generator<RemoteManager>* RemoteManager::generator (  utils::SymbolTable *  table  )  [static]

Get the remote manager generator from the symbol table. Parameters: [in]  table The symbol table Returns: Returns (creating if necessary) the generator.

com_id_t RemoteManager::getID (   )  const [inline]

This method returns the last known identifier for the remote communication manager.

TimeStamp RemoteManager::getTimeStamp (   )  const [inline]

This method returns the timestamp of the last message received from the remote communication manager.

int RemoteManager::lastContactTime (   )

This method returns the number of milliseconds since the last message was received from the remote communications manager.

virtual bool RemoteManager::sendMsg (  Message *  msg, unsigned char *  preamble = NULL, int  preamble_size = 0 )  [pure virtual]

Sends a message to the remote manager Parameters: [in]  msg The message to send. If no message, just send the preamble [in]  preamble If there, precede the message data with the preamble data [in]  preamble_size If there, the size of the preamble data Returns: Return true if successful, false if not Implemented in NetRemoteManager, and SerialRemoteManager.

---

RHexLib Reference Documentation