Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

gov::cca::MPIBorrow Class Reference

UNADOPTED standard service. More...

#include <MPIBorrow.h>

Inheritance diagram for gov::cca::MPIBorrow:

Inheritance graph
[legend]
Collaboration diagram for gov::cca::MPIBorrow:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual ~MPIBorrow ()
 obligatory vdtor. More...

virtual MPI_Comm borrowComm (int tagCount, int *tagList, int &key)=0
 Get a communicator of the port provider. More...

virtual void returnComm (MPI_Comm, int tagCount, int *tagList, int key)=0
 Return a previously borrowed communicator and tag list. More...


Detailed Description

UNADOPTED standard service.

Port string name "gov.cca.MPIBorrow".


Constructor & Destructor Documentation

virtual gov::cca::MPIBorrow::~MPIBorrow   [inline, virtual]
 

obligatory vdtor.

00018 {}


Member Function Documentation

virtual MPI_Comm gov::cca::MPIBorrow::borrowComm int    tagCount,
int *    tagList,
int &    key
[pure virtual]
 

Get a communicator of the port provider.

This communicator will be the same instance as the comm of the port provider, with all the message collision potential that implies. Instances which have a comm covering only a subset of themselves may return MPI_COMM_NULL on their "un-covered" processes.

Parameters:
tagCount  Input: The number of tags the borrower wishes to use all to itself.
tagList  Output: Array to be filled with tags available. The array given is tagCount long.
key  Output: key to be returned when the tags and comm are done with.
Returns:
The comm being borrowed.

virtual void gov::cca::MPIBorrow::returnComm MPI_Comm   ,
int    tagCount,
int *    tagList,
int    key
[pure virtual]
 

Return a previously borrowed communicator and tag list.

Parameters:
tagCount  Input: The length of tagList.
tagList  Input: The tags being returned, tagCount long.
key  Input: The key obtained with borrowComm. It is an error to attempt to return tags that you didn't receive.
Returns:
-1 if an error is detected, 0 otherwise.


The documentation for this class was generated from the following file:
Generated on Tue Aug 20 14:30:32 2002 for CCA Specification/Proposals by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002