---

PsnPvmSvmLink Class Reference

a Pvm communication chanel. More...

#include <PsnPvmSvmLink.h>

Inheritance diagram for PsnPvmSvmLink:

[legend]Collaboration diagram for PsnPvmSvmLink:

[legend]List of all members.

Public Methods
	PsnPvmSvmLink (int td)
	Constructor.
virtual	~PsnPvmSvmLink ()
	Destructor.
virtual void	send (PsnPvmOutgoingMessage &m, PsnPvmMessage::MessageTag tag)
	send a specific outgoing message along the link
PsnPvmIncomingMessage &	waitForMessage (PsnPvmMessage::MessageTag tag)
	wait for a message comming along the link and receive it
PsnPvmIncomingMessage *	testForMessage (PsnPvmMessage::MessageTag tag)
	testForMessage.
virtual PsnPvmMessage::MessageTag	testForAnyMessage (PsnPvmIncomingMessage &receiveBuffer)
	test for any message sent to this site from a specified site.
virtual void	unpack (PsIncomingSynchronisationMessage &)
	unpack from a message
virtual void	pack (PsOutgoingSynchronisationMessage &) const
	pack in a message
virtual PsnPvmOutgoingMessage &	getOutgoingBuffer ()
	get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer
void	sendOutgoingBuffer (PsnPvmMessage::MessageTag tag)
	send the outgoingBuffer
int	getTID ()
	get the site id of the process at the other end of the link
void	printDebuggingInformation ()
	printDebugging information
Protected Attributes
PsnPvmUnicastMessage	_outgoingBuffer
	standard outgoing buffer for that link
PsnPvmIncomingMessage	_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 28 of file PsnPvmSvmLink.h.

---

Constructor & Destructor Documentation

PsnPvmSvmLink::PsnPvmSvmLink (  int    td )

Constructor. Definition at line 30 of file PsnPvmSvmLink.cxx. : PsnSvmLink(), _outgoingBuffer ( td ), _distantSiteId ( td ) { }

PsnPvmSvmLink::~PsnPvmSvmLink (    )  [virtual]

Destructor. Definition at line 39 of file PsnPvmSvmLink.cxx. { }

---

Member Function Documentation

PsnPvmOutgoingMessage & PsnPvmSvmLink::getOutgoingBuffer (    )  [virtual]

get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer Implements PsnSvmLink. Definition at line 195 of file PsnPvmSvmLink.cxx. References _outgoingBuffer. { return _outgoingBuffer ; }

int PsnPvmSvmLink::getTID (    )  [virtual]

get the site id of the process at the other end of the link Implements PsnSvmLink. Definition at line 169 of file PsnPvmSvmLink.cxx. References _distantSiteId. { return _distantSiteId ; }

void PsnPvmSvmLink::pack (  PsOutgoingSynchronisationMessage &    )  const [virtual]

pack in a message Implements PsPackable. Definition at line 174 of file PsnPvmSvmLink.cxx. References _distantSiteId. { out << _distantSiteId ; }

void PsnPvmSvmLink::printDebuggingInformation (    )  [virtual]

printDebugging information Implements PsnSvmLink. Definition at line 162 of file PsnPvmSvmLink.cxx. References _distantSiteId. { cerr << "PsnPvmSvmLink:"<<this<<":printDebuggingInformation:_distantSiteIdant : " << hex << _distantSiteId << dec << endl ; }

void PsnPvmSvmLink::send (  PsnPvmOutgoingMessage &    m, PsnPvmMessage::MessageTag    tag )  [virtual]

send a specific outgoing message along the link Parameters: m  the message to send the  tag associated to the message Implements PsnSvmLink. Definition at line 45 of file PsnPvmSvmLink.cxx. References PsnPvmMessage::MessageTag, and PsnPvmOutgoingMessage::send(). { m.send ( tag ) ; }

void PsnPvmSvmLink::sendOutgoingBuffer (  PsnPvmMessage::MessageTag    tag )  [virtual]

send the outgoingBuffer Parameters: tag  the tag to send the outgoing message with Implements PsnSvmLink. Definition at line 52 of file PsnPvmSvmLink.cxx. References _outgoingBuffer, PsnPvmMessage::MessageTag, and PsnPvmUnicastMessage::send(). { #ifdef _DEBUGPVMMESS cerr << "PsnPvmSvmLink::sendOutgoingBuffer ("<< force << "," << tag <<") "<<endl; #endif _outgoingBuffer.send ( tag ) ; }

PsnPvmMessage::MessageTag PsnPvmSvmLink::testForAnyMessage (  PsnPvmIncomingMessage &    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 PsnSvmLink. Definition at line 97 of file PsnPvmSvmLink.cxx. References _distantSiteId, PsController::FatalWarnings, PsnPvmIncomingMessage::initialise(), PsnPvmMessage::MessageTag, and PsController::warningLevel. { PsnPvmMessage::MessageTag result ; int bufid = pvm_nrecv ( _distantSiteId, -1 ) ; //test if any message has arrived from distantDiteId if ( bufid < 0 ) { cerr<<"PsnSvm::waitForAnyRequests ERROR "; switch (bufid) { case PvmBadParam: cerr<<"giving an invalid tid value, or msgtag < -1"; break; case PvmSysErr: cerr<<"pvmd not responding"; break; default: cerr<<"unexpected error"; if (PsController::warningLevel >= PsController::FatalWarnings) { exit (2) ; } } cerr<<endl; } if ( bufid != 0 ) { int bytes ; int senderSiteId ; int msgtag ; int info = pvm_bufinfo( bufid, &bytes , &msgtag , &senderSiteId ) ; result = static_cast<PsnPvmMessage::MessageTag>(msgtag) ; if ( info < 0 ) { cerr<<"PsnSvm::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"; if (PsController::warningLevel >= PsController::FatalWarnings) { exit (2) ; } } cerr<<endl; } } receiveBuffer.initialise ( bufid ) ; return result ; }

PsnPvmIncomingMessage * PsnPvmSvmLink::testForMessage (  PsnPvmMessage::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 PsnSvmLink. Definition at line 77 of file PsnPvmSvmLink.cxx. References _distantSiteId, _incomingBuffer, PsnPvmIncomingMessage::initialise(), and PsnPvmMessage::MessageTag. { #ifdef _DEBUGPVMMESS cerr << "PsnPvmSvmLink::testForMessage: tag " <<tag<<endl; #endif int res = pvm_nrecv (_distantSiteId, tag) ; if (res >= 0) { _incomingBuffer.initialise ( res ); return &_incomingBuffer ; } else { return NULL ; } }

void PsnPvmSvmLink::unpack (  PsIncomingSynchronisationMessage &    )  [virtual]

unpack from a message Implements PsPackable. Definition at line 180 of file PsnPvmSvmLink.cxx. References _distantSiteId, _outgoingBuffer, and PsnPvmUnicastMessage::setDistantSiteId(). { #ifdef _DEBUGPVMMESS cerr<<"PsnPvmSvmLink::unpack: "; #endif in >> _distantSiteId ; _outgoingBuffer.setDistantSiteId ( _distantSiteId ) ; #ifdef _DEBUGPVMMESS cerr<<"distant site Id: "<<_distantSiteId<<endl; #endif }

PsnPvmIncomingMessage & PsnPvmSvmLink::waitForMessage (  PsnPvmMessage::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 PsnSvmLink. Definition at line 62 of file PsnPvmSvmLink.cxx. References _distantSiteId, _incomingBuffer, PsnPvmIncomingMessage::initialise(), and PsnPvmMessage::MessageTag. { // 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 ; }

---

Member Data Documentation

int PsnPvmSvmLink::_distantSiteId [protected]

distant workstation site id for that link Definition at line 98 of file PsnPvmSvmLink.h. Referenced by getTID(), pack(), printDebuggingInformation(), testForAnyMessage(), testForMessage(), unpack(), and waitForMessage().

PsnPvmIncomingMessage PsnPvmSvmLink::_incomingBuffer [protected]

standard incomming buffer for that link Definition at line 95 of file PsnPvmSvmLink.h. Referenced by testForMessage(), and waitForMessage().

PsnPvmUnicastMessage PsnPvmSvmLink::_outgoingBuffer [protected]

standard outgoing buffer for that link Definition at line 92 of file PsnPvmSvmLink.h. Referenced by getOutgoingBuffer(), sendOutgoingBuffer(), and unpack().

---

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

• PsnPvmSvmLink.h
• PsnPvmSvmLink.cxx

---