OMK::PvmIncomingMessage Class Reference

Defining a received message for a message passing architecture. More...

#include <OMKPvmIncomingMessage.h>

Inheritance diagram for OMK::PvmIncomingMessage:

[legend]Collaboration diagram for OMK::PvmIncomingMessage:

[legend]List of all members.

Public Member Functions
	PvmIncomingMessage ()
	constructor with no associated message
	PvmIncomingMessage (int bufId)
	constructor used to initialise by saving the receive buffer whithout interpretation of the contents of the buffer
virtual const Date &	getMessageDate ()
	The timestamp of the incomming message.
virtual void	initialise (int bufId)
	initialise the receive buffer with a received buffer
virtual void	deleteCurrentBuffer ()
	delete a received buffer
virtual bool	hasMessage () const
	test to see if there is a message in the incoming buffer
virtual	~PvmIncomingMessage ()
	Destructor.
virtual void	get (bool &val)
	get a bool in the message
virtual void	get (char &val)
	get a char in the message
virtual void	get (long &val)
	get a long in the message
virtual void	get (unsigned long &val)
	get an unsigned long in the message
virtual void	get (int &val)
	get an int in the message
virtual void	get (unsigned int &val)
	get an unsigned int in the message
virtual void	get (float &val)
	get a float in the message
virtual void	get (double &val)
	get a double in the message
virtual void	get (short &val)
	get a short in the message
virtual void	get (unsigned short &val)
	get an unsigned short in the message
virtual void	get (char *val)
	get a C style string, whithout it's length which should be gotten first if the string isn't of constant length
virtual void	get (std::string &val)
	get a string Warning : this isn't natively supported by PVM, so using this method, a copy of the string is first made from the buffer, then a copy to val !
virtual void	get (char *val, int cnt)
	get a char in the message
virtual void	get (long *val, int cnt)
	get a long in the message
virtual void	get (unsigned long *val, int cnt)
	get an unsigned long in the message
virtual void	get (int *val, int cnt)
	get an int in the message
virtual void	get (unsigned int *val, int cnt)
	get an unsigned int in the message
virtual void	get (float *val, int cnt)
	get a float in the message
virtual void	get (double *val, int cnt)
	get a double in the message
virtual void	get (short *val, int cnt)
	get a short in the message
virtual void	get (unsigned short *val, int cnt)
	get an unsigned short in the message
Static Public Attributes
static int	pvmActiveBuffer
	only used for debugging purposes, as this class serves as interface between the context sensitive notion of active buffers of Pvm and the context free incomingMessages
Protected Member Functions
virtual void	checkForGetErrors (int info)
	member function ensuring awarness of geting errors
Protected Attributes
OMK::Type::SimpleTypeT< Date >	_messageTimestamp
	date associated to the current message

---

Detailed Description

Defining a received message for a message passing architecture.

Author:

David Margery (version 1.0 by Siames)

Version:

2.2

• 1.0 -> 2.0 by D. Margery: reimplemented to avoid unnecessary copies
• 2.0 -> 2.1 by D. Margery ( 2002/04/08): inheritance from IncomingSynchronisationMessage
• 2.1 -> 2.2 by D. Margery ( 2002/08/08): added the getMessageDate member function and changed default protocol so that the timestamp existance is now implicit and only decoded once
• 2.2 -> 2.3 by D. Margery ( 2002/10/28): added support for the bool type

Definition at line 21 of file OMKPvmIncomingMessage.h.

---

Constructor & Destructor Documentation

PvmIncomingMessage::PvmIncomingMessage

(

)

constructor with no associated message

Definition at line 15 of file OMKPvmIncomingMessage.cxx.

                                       :
   IncomingSynchronisationMessage (),
   PvmMessage (0)
{

}

PvmIncomingMessage::PvmIncomingMessage

(

int

bufId

)

constructor used to initialise by saving the receive buffer whithout interpretation of the contents of the buffer

Definition at line 24 of file OMKPvmIncomingMessage.cxx.

References pvmActiveBuffer.

                                                :
   IncomingSynchronisationMessage (),
   PvmMessage (bufId)
{
  pvmActiveBuffer = bufId ;
}

PvmIncomingMessage::~PvmIncomingMessage

(

)

[virtual]

Destructor.

Definition at line 52 of file OMKPvmIncomingMessage.cxx.

{

}

---

Member Function Documentation

const Date & PvmIncomingMessage::getMessageDate

(

)

[virtual]

The timestamp of the incomming message.

Implements OMK::IncomingSynchronisationMessage.

Definition at line 57 of file OMKPvmIncomingMessage.cxx.

References _messageTimestamp.

Referenced by OMK::Svm::processReceivedMessages(), OMK::Svm::serveNameRequestsUntilEnd(), and OMK::Svm::waitForAnswerToBlockingRequest().

{
   return _messageTimestamp ;
}

void PvmIncomingMessage::initialise

(

int

bufId

)

[virtual]

initialise the receive buffer with a received buffer

Definition at line 33 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, _messageTimestamp, OMK::IncomingSynchronisationMessage::_myis, and pvmActiveBuffer.

Referenced by OMK::PvmSvmLink::testForAnyMessage(), OMK::PvmSvmLink::testForMessage(), OMK::PvmSvmLink::testIfRequestUpdateProcessTable(), OMK::PvmSvm::waitForAnyRequests(), and OMK::PvmSvmLink::waitForMessage().

{
  _currentBuffer = bufId ;
  pvmActiveBuffer = bufId ;
  if (_myis != 0 )
    {
      delete _myis ;
      _myis = 0 ;
    }
  if (_currentBuffer != 0) _messageTimestamp.unpack(*this) ;
}

void PvmIncomingMessage::deleteCurrentBuffer

(

)

[virtual]

delete a received buffer

Definition at line 45 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer.

{
  pvm_freebuf(_currentBuffer);
}

bool PvmIncomingMessage::hasMessage

(

)

const [virtual]

test to see if there is a message in the incoming buffer

Definition at line 62 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer.

Referenced by OMK::Svm::processReceivedMessages(), OMK::Svm::relaxedSynchroniseReceiveAndProcessMessages(), OMK::Svm::synchroniseReceiveAndProcessMessages(), and OMK::Svm::waitForMessage().

{
   return _currentBuffer != 0 ;
}

void PvmIncomingMessage::get

(

bool &

val

)

[virtual]

get a bool in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 96 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
   assert ( pvmActiveBuffer == _currentBuffer ) ;
   char realVal ;
   int info = pvm_upkbyte ( &realVal, 1, 1 ) ;
   val = realVal ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (char & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
   checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

char &

val

)

[virtual]

get a char in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 109 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
   assert ( pvmActiveBuffer == _currentBuffer ) ;
   int info = pvm_upkbyte ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (char & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
   checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

long &

val

)

[virtual]

get a long in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 120 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
   assert ( pvmActiveBuffer == _currentBuffer ) ;
   int info = pvm_upklong ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (long & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
   checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

unsigned long &

val

)

[virtual]

get an unsigned long in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 133 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkulong ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned long & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

int &

val

)

[virtual]

get an int in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 147 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkint ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (int & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

unsigned int &

val

)

[virtual]

get an unsigned int in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 159 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkuint ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned int & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

float &

val

)

[virtual]

get a float in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 172 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkfloat ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (float & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

double &

val

)

[virtual]

get a double in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 185 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkdouble ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (double & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

short &

val

)

[virtual]

get a short in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 198 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkshort ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (short & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

unsigned short &

val

)

[virtual]

get an unsigned short in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 210 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkushort ( &val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned short & "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

char *

val

)

[virtual]

get a C style string, whithout it's length which should be gotten first if the string isn't of constant length

Implements OMK::IncomingSynchronisationMessage.

Definition at line 222 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkstr ( ch ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (char * "<<ch<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get

(

std::string &

val

)

[virtual]

get a string Warning : this isn't natively supported by PVM, so using this method, a copy of the string is first made from the buffer, then a copy to val !

Implements OMK::IncomingSynchronisationMessage.

Definition at line 233 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );

  unsigned int stringSize ;
  int info = pvm_upkuint ( &stringSize, 1, 1 ) ;
  checkForGetErrors ( info ) ;

  char * Cstr = new char [stringSize] ;

  info = pvm_upkstr ( Cstr ) ;
  checkForGetErrors ( info ) ;
  assert (Cstr[stringSize-1] == '\0' ) ;

  str = Cstr ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (std::string & "<<str<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  delete [] Cstr ;

}

void PvmIncomingMessage::get	(	char *	val,
		int	cnt
	)			[virtual]

get a char in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 254 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
   assert ( pvmActiveBuffer == _currentBuffer ) ;
   int info = pvm_upkbyte ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (char * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
   checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	long *	val,
		int	cnt
	)			[virtual]

get a long in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 265 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
   assert ( pvmActiveBuffer == _currentBuffer ) ;
   int info = pvm_upklong ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (long * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
   checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	unsigned long *	val,
		int	cnt
	)			[virtual]

get an unsigned long in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 278 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkulong ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned long * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	int *	val,
		int	cnt
	)			[virtual]

get an int in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 292 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkint ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (int * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	unsigned int *	val,
		int	cnt
	)			[virtual]

get an unsigned int in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 304 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkuint ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned int * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	float *	val,
		int	cnt
	)			[virtual]

get a float in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 317 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkfloat ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (float * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	double *	val,
		int	cnt
	)			[virtual]

get a double in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 330 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkdouble ( val, 1, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (double * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	short *	val,
		int	cnt
	)			[virtual]

get a short in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 343 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkshort ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (short * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::get	(	unsigned short *	val,
		int	cnt
	)			[virtual]

get an unsigned short in the message

Implements OMK::IncomingSynchronisationMessage.

Definition at line 355 of file OMKPvmIncomingMessage.cxx.

References OMK::PvmMessage::_currentBuffer, checkForGetErrors(), and pvmActiveBuffer.

{
  assert ( pvmActiveBuffer == _currentBuffer );
  int info = pvm_upkushort ( val, cnt, 1 ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"PvmIncomingMessage::get (unsigned short * "<<val<<" )"<< " Buffer " << _currentBuffer << endl;
#endif
  checkForGetErrors ( info ) ;
}

void PvmIncomingMessage::checkForGetErrors

(

int

info

)

[protected, virtual]

member function ensuring awarness of geting errors

Definition at line 69 of file OMKPvmIncomingMessage.cxx.

References OMASSERT.

Referenced by get().

{
  if (info < 0 )
    {
      cerr<<"PvmIncomingMessage::checkForGetErrors ERROR ";
      assert ( false ) ;
      switch ( info ) 
        {
        case PvmNoData:
          cerr<<"Reading beyond the end of the receive buffer. Most likely cause is trying to get more items than were originally packed into the buffer. This can also happen if a new reception without buffer saving happened in the course of geting all the data of a previous message";
          break;
        case PvmNoBuf:
          cerr<<"There is no active receive buffer to get.";
          break;
        case PvmBadMsg:
           cerr<<"The received message can to be decoded. Most likely because the hosts are heterogeneous and the users specified an incompatible encoding.";
          break;
        default:
          cerr<<"unexpected error: ";
        }
      cerr<<endl;         
        OMASSERT( false ) ;
    }
}

---

Member Data Documentation

int PvmIncomingMessage::pvmActiveBuffer [static]

only used for debugging purposes, as this class serves as interface between the context sensitive notion of active buffers of Pvm and the context free incomingMessages

Definition at line 122 of file OMKPvmIncomingMessage.h.

Referenced by get(), initialise(), and PvmIncomingMessage().

OMK::Type::SimpleTypeT< Date > OMK::PvmIncomingMessage::_messageTimestamp [protected]

date associated to the current message

Definition at line 129 of file OMKPvmIncomingMessage.h.

Referenced by getMessageDate(), and initialise().

---