OMK::PvmSvmLink Class Reference

a Pvm communication chanel. More...

#include <OMKPvmSvmLink.h>

Inheritance diagram for OMK::PvmSvmLink:

[legend]Collaboration diagram for OMK::PvmSvmLink:

[legend]List of all members.

Public Member Functions
	PvmSvmLink (int td)
	Constructor.
virtual	~PvmSvmLink ()
	Destructor.
virtual void	send (PvmOutgoingMessage &m, PvmMessage::MessageTag tag)
	send a specific outgoing message along the link
virtual PvmIncomingMessage &	waitForMessage (PvmMessage::MessageTag tag)
	wait for a message comming along the link and receive it
virtual PvmIncomingMessage *	testForMessage (PvmMessage::MessageTag tag)
	testForMessage.
virtual PvmIncomingMessage *	testIfRequestUpdateProcessTable (PvmMessage::MessageTag tag)
	CHADI.
virtual PvmMessage::MessageTag	testForAnyMessage (PvmIncomingMessage &receiveBuffer)
	test for any message sent to this site from a specified site.
virtual void	unpack (IncomingSynchronisationMessage &)
	unpack from a message
virtual void	pack (OutgoingSynchronisationMessage &) const
	pack in a message
virtual PvmOutgoingMessage &	getOutgoingBuffer ()
	get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer
void	sendOutgoingBuffer (PvmMessage::MessageTag tag)
	send the outgoingBuffer
virtual int	getTID ()
	get the site id of the process at the other end of the link
virtual void	printDebuggingInformation ()
	printDebugging information
Protected Attributes
PvmUnicastMessage	_outgoingBuffer
	standard outgoing buffer for that link
PvmIncomingMessage	_incomingBuffer
	standard incomming buffer for that link
int	_distantSiteId
	distant workstation site id for that link

---

Detailed Description

a Pvm communication chanel.

Author:

Siames

Version:

2.0

• 1.0 -> 2.0 by David Margery : added complete support for incomming and outgoing buffers suplied by the user

Definition at line 30 of file OMKPvmSvmLink.h.

---

Constructor & Destructor Documentation

PvmSvmLink::PvmSvmLink

(

int

td

)

Constructor.

Definition at line 30 of file OMKPvmSvmLink.cxx.

                              : 
  SvmLink(),
  _outgoingBuffer ( td ),
  _distantSiteId ( td ) 
{
}

PvmSvmLink::~PvmSvmLink

(

)

[virtual]

Destructor.

Definition at line 39 of file OMKPvmSvmLink.cxx.

{
}

---

Member Function Documentation

void PvmSvmLink::send	(	PvmOutgoingMessage &	m,
		PvmMessage::MessageTag	tag
	)			[virtual]

send a specific outgoing message along the link

Parameters:

	m	the message to send
	the	tag associated to the message

Implements OMK::SvmLink.

Definition at line 45 of file OMKPvmSvmLink.cxx.

References OMK::PvmOutgoingMessage::send().

{
  m.send ( tag ) ;
}

PvmIncomingMessage & PvmSvmLink::waitForMessage

(

PvmMessage::MessageTag

tag

)

[virtual]

wait for a message comming along the link and receive it

Parameters:

tag

the tag of the message to wait for

Implements OMK::SvmLink.

Definition at line 62 of file OMKPvmSvmLink.cxx.

References _distantSiteId, _incomingBuffer, and OMK::PvmIncomingMessage::initialise().

{
  // attente en reception
  int res = pvm_recv (_distantSiteId, tag) ;
   
  _incomingBuffer.initialise ( res ) ;
#ifdef _DEBUGPVMMESS
  cerr << "waitForMessage : On recoit un message  tag: " << tag << " de " << hex << _distantSiteId << dec << endl;
#endif
  // On renvoie le message
  return _incomingBuffer ;
}

PvmIncomingMessage * PvmSvmLink::testForMessage

(

PvmMessage::MessageTag

tag

)

[virtual]

testForMessage.

Test to see if a message has arrived and receive it

Parameters:

tag

the tag of the message to wait for

Returns:

NULL if no message was present, a incoming buffer with the message otherwise. This incoming buffer should not be deleted

Implements OMK::SvmLink.

Definition at line 77 of file OMKPvmSvmLink.cxx.

References _distantSiteId, _incomingBuffer, and OMK::PvmIncomingMessage::initialise().

{
#ifdef _DEBUGPVMMESS
  cerr << "PvmSvmLink::testForMessage: tag  " <<tag<<endl;
#endif        

  int res = pvm_nrecv (_distantSiteId, tag) ;

  if (res >= 0) 
    { 
      _incomingBuffer.initialise ( res );
      return &_incomingBuffer ;
    } 
  else 
    {
      return NULL ;
    }
}

PvmIncomingMessage * PvmSvmLink::testIfRequestUpdateProcessTable

(

PvmMessage::MessageTag

tag

)

[virtual]

CHADI.

Implements OMK::SvmLink.

Definition at line 97 of file OMKPvmSvmLink.cxx.

References _distantSiteId, _incomingBuffer, OMK::PvmIncomingMessage::initialise(), and OMK::PvmMessage::updateProcessTable.

{
#ifdef _DEBUGPVMMESS
  cerr << "PvmSvmLink::testForMessage: tag  " <<tag<<endl;
#endif        
 
  int res = pvm_nrecv (_distantSiteId, PvmMessage::updateProcessTable) ;
 
  if (res > 0) 
    { 
      _incomingBuffer.initialise ( res );
      return &_incomingBuffer ;
    } 
  else 
    {
      return NULL ;
    }
}

PvmMessage::MessageTag PvmSvmLink::testForAnyMessage

(

PvmIncomingMessage &

receiveBuffer

)

[virtual]

test for any message sent to this site from a specified site.

This call is non blocking

Parameters:

receiveBuffer

: the user buffer to use to receive any message the tag of the received message

Implements OMK::SvmLink.

Definition at line 118 of file OMKPvmSvmLink.cxx.

References _distantSiteId, OMK::PvmIncomingMessage::initialise(), and OMASSERT.

{
  PvmMessage::MessageTag result ;
  
  int bufid = pvm_nrecv  ( _distantSiteId, -1 ) ; //test if any message has arrived from distantDiteId

  if ( bufid < 0 ) 
    {
      std::cerr<<"Svm::waitForAnyRequests ERROR ";
      switch (bufid)
        {
        case PvmBadParam:
          std::cerr<<"giving an invalid tid value, or msgtag < -1";
          break;
        case PvmSysErr:
          std::cerr<<"pvmd not responding";
          break;
        default:
          std::cerr<<"unexpected error";
                OMASSERT( false ) ;
        }
      std::cerr<<std::endl;
    }

  if ( bufid != 0 )
    {
      int bytes ;
      int senderSiteId ;
      int msgtag ;
      int info = pvm_bufinfo( bufid, &bytes , &msgtag , &senderSiteId  ) ;
        
      result = static_cast<PvmMessage::MessageTag>(msgtag) ;
        
      if ( info < 0 ) 
        {
          cerr<<"Svm::waitForAnyRequests ERROR in pvm_bufinfo ";
          switch (info)
            {
            case PvmBadParam:
              cerr<<"invalid argument";
              break;
            case PvmNoSuchBuf:
              cerr<<"specified buffer does not exist";
              break;
            default:
              cerr<<"unexpected error";
                OMASSERT( false ) ;
            }
          cerr<<endl;
        }
    }

  receiveBuffer.initialise ( bufid ) ;
  
  return result ;
}

void PvmSvmLink::unpack

(

IncomingSynchronisationMessage &

)

[virtual]

unpack from a message

Implements OMK::Packable.

Definition at line 195 of file OMKPvmSvmLink.cxx.

References _distantSiteId, _outgoingBuffer, and OMK::PvmUnicastMessage::setDistantSiteId().

{
#ifdef _DEBUGPVMMESS
  cerr<<"PvmSvmLink::unpack: ";
#endif
  in >> _distantSiteId ;

  _outgoingBuffer.setDistantSiteId ( _distantSiteId ) ;
#ifdef _DEBUGPVMMESS
  cerr<<"distant site Id: "<<_distantSiteId<<endl;
#endif
}

void PvmSvmLink::pack

(

OutgoingSynchronisationMessage &

)

const [virtual]

pack in a message

Implements OMK::Packable.

Definition at line 189 of file OMKPvmSvmLink.cxx.

References _distantSiteId.

{
  out << _distantSiteId ;
}

PvmOutgoingMessage & PvmSvmLink::getOutgoingBuffer

(

)

[virtual]

get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer

Implements OMK::SvmLink.

Definition at line 210 of file OMKPvmSvmLink.cxx.

References _outgoingBuffer.

{
  return _outgoingBuffer ;
}

void PvmSvmLink::sendOutgoingBuffer

(

PvmMessage::MessageTag

tag

)

[virtual]

send the outgoingBuffer

Parameters:

tag

the tag to send the outgoing message with

Implements OMK::SvmLink.

Definition at line 52 of file OMKPvmSvmLink.cxx.

References _outgoingBuffer, and OMK::PvmUnicastMessage::send().

{
#ifdef _DEBUGPVMMESS
  cerr << "PvmSvmLink::sendOutgoingBuffer (" << tag <<") "<<endl;
#endif
  _outgoingBuffer.send ( tag ) ;
}

int PvmSvmLink::getTID

(

)

[virtual]

get the site id of the process at the other end of the link

Implements OMK::SvmLink.

Definition at line 184 of file OMKPvmSvmLink.cxx.

References _distantSiteId.

{
  return _distantSiteId ;
}

void PvmSvmLink::printDebuggingInformation

(

)

[virtual]

printDebugging information

Implements OMK::SvmLink.

Definition at line 177 of file OMKPvmSvmLink.cxx.

References _distantSiteId.

{
  cerr << "PvmSvmLink:"<<this<<":printDebuggingInformation:_distantSiteIdant : " << hex << _distantSiteId << dec << endl ;
}

---

Member Data Documentation

PvmUnicastMessage OMK::PvmSvmLink::_outgoingBuffer [protected]

standard outgoing buffer for that link

Definition at line 99 of file OMKPvmSvmLink.h.

Referenced by getOutgoingBuffer(), sendOutgoingBuffer(), and unpack().

PvmIncomingMessage OMK::PvmSvmLink::_incomingBuffer [protected]

standard incomming buffer for that link

Definition at line 102 of file OMKPvmSvmLink.h.

Referenced by testForMessage(), testIfRequestUpdateProcessTable(), and waitForMessage().

int OMK::PvmSvmLink::_distantSiteId [protected]

distant workstation site id for that link

Definition at line 105 of file OMKPvmSvmLink.h.

Referenced by getTID(), pack(), printDebuggingInformation(), testForAnyMessage(), testForMessage(), testIfRequestUpdateProcessTable(), unpack(), and waitForMessage().

---