---

PsnSvmLink Class Reference

defines a communication chanel More...

#include <PsnSvmLink.h>

Inheritance diagram for PsnSvmLink:

[legend]Collaboration diagram for PsnSvmLink:

[legend]List of all members.

Public Methods
	PsnSvmLink ()
	Constructor.
virtual	~PsnSvmLink ()
	Destructor.
virtual void	send (PsnPvmOutgoingMessage &m, PsnPvmMessage::MessageTag tag)=0
	send a specific outgoing message along the link
virtual PsnPvmIncomingMessage &	waitForMessage (PsnPvmMessage::MessageTag tag)=0
	wait for a message comming along the link and receive it
virtual PsnPvmIncomingMessage *	testForMessage (PsnPvmMessage::MessageTag tag)=0
	testForMessage.
virtual PsnPvmMessage::MessageTag	testForAnyMessage (PsnPvmIncomingMessage &receiveBuffer)=0
	test for any message sent to this site from a specified site.
virtual PsnPvmOutgoingMessage &	getOutgoingBuffer ()=0
	get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer
virtual void	sendOutgoingBuffer (PsnPvmMessage::MessageTag tag)=0
	send the outgoingBuffer
virtual int	getTID ()=0
	get the site id of the process at the other end of the link
virtual void	printDebuggingInformation ()=0
	printDebugging information

---

Detailed Description

defines a communication chanel

Author:

Siames

Version:

1.0

Definition at line 31 of file PsnSvmLink.h.

---

Constructor & Destructor Documentation

PsnSvmLink::PsnSvmLink (    )

Constructor. Definition at line 3 of file PsnSvmLink.cxx. : PsPackable() { }

PsnSvmLink::~PsnSvmLink (    )  [virtual]

Destructor. Definition at line 7 of file PsnSvmLink.cxx. { }

---

Member Function Documentation

virtual PsnPvmOutgoingMessage& PsnSvmLink::getOutgoingBuffer (    )  [pure virtual]

get the outgoing buffer which will be sent at the next call of sendOutgoingBuffer Implemented in PsnPvmSvmLink. Referenced by PsnMirrorObjectHandle::cancelRegistrationForSignal(), PsnSvm::createDistributedSimulation(), PsnMirrorObjectHandle::receiveEvent(), PsnMirrorObjectHandle::receiveRegistrationForSignal(), and PsnMirrorObjectHandle::sendRequestToReferenceObject().

virtual int PsnSvmLink::getTID (    )  [pure virtual]

get the site id of the process at the other end of the link Implemented in PsnPvmSvmLink. Referenced by PsnSvm::connectToDistributedSimulation(), PsnSvm::createDistributedSimulation(), and PsnMirrorObjectHandle::registerToReferenceObject().

virtual void PsnSvmLink::printDebuggingInformation (    )  [pure virtual]

printDebugging information Implemented in PsnPvmSvmLink.

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

send a specific outgoing message along the link Parameters: m  the message to send the  tag associated to the message Implemented in PsnPvmSvmLink.

virtual void PsnSvmLink::sendOutgoingBuffer (  PsnPvmMessage::MessageTag    tag )  [pure virtual]

send the outgoingBuffer Parameters: tag  the tag to send the outgoing message with Implemented in PsnPvmSvmLink. Referenced by PsnSvm::sendCurrentBuffersWithTag().

virtual PsnPvmMessage::MessageTag PsnSvmLink::testForAnyMessage (  PsnPvmIncomingMessage &    receiveBuffer )  [pure 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 Implemented in PsnPvmSvmLink. Referenced by PsnSvm::synchroniseReceiveAndProcessMessages().

virtual PsnPvmIncomingMessage* PsnSvmLink::testForMessage (  PsnPvmMessage::MessageTag    tag )  [pure 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 Implemented in PsnPvmSvmLink. Referenced by PsnSvm::processReceivedMessages(), and PsnSvm::waitForMessage().

virtual PsnPvmIncomingMessage& PsnSvmLink::waitForMessage (  PsnPvmMessage::MessageTag    tag )  [pure virtual]

wait for a message comming along the link and receive it Parameters: tag  the tag of the message to wait for Implemented in PsnPvmSvmLink. Referenced by PsnSvm::connectToDistributedSimulation(), PsnSvm::waitAndProcessMessages(), and PsnSvm::waitForMessageFrom().

---

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

• PsnSvmLink.h
• PsnSvmLink.cxx

---