classic_gov_cca_MPIBorrow(3)
| classic::gov::cca::MPIBorrow(3) | 'Classic' CCA c++ binding (ccaffeine-only) | classic::gov::cca::MPIBorrow(3) |
NAME
classic::gov::cca::MPIBorrow -
UNADOPTED standard service.
SYNOPSIS
#include <MPIBorrow.h>
Inherits classic::gov::cca::Port.
Public Member Functions
virtual ~MPIBorrow ()
obligatory vdtor virtual MPI_Comm borrowComm (int tagCount, int
*tagList, int &key) CLASSIC_CCA_PURE
Get a communicator of the port provider. virtual void
returnComm (MPI_Comm, int tagCount, int *tagList, int key)
CLASSIC_CCA_PURE
Return a previously borrowed communicator and tag list.
Detailed Description
UNADOPTED standard service.
Port string name 'gov.cca.MPIBorrow'.
Constructor & Destructor Documentation
virtual classic::gov::cca::MPIBorrow::~MPIBorrow () [inline, virtual]
obligatory vdtor
{}
Member Function Documentation
virtual MPI_Comm classic::gov::cca::MPIBorrow::borrowComm (inttagCount, int *tagList, int &key) [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:
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:
virtual void classic::gov::cca::MPIBorrow::returnComm (MPI_Comm, inttagCount, int *tagList, intkey) [virtual]
Return a previously borrowed communicator and tag list. Parameters:
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:
Author
Generated automatically by Doxygen for 'Classic' CCA c++ binding (ccaffeine-only) from the source code.
| Tue Nov 12 2013 | Version 0.5.7 |