cca-spec-babel  0.8.6-unstable(developer)
Public Member Functions
gov.cca.ports.MPIBorrow Interface Reference
Inheritance diagram for gov.cca.ports.MPIBorrow:
Inheritance graph
[legend]
Collaboration diagram for gov.cca.ports.MPIBorrow:
Collaboration graph
[legend]

List of all members.

Public Member Functions

long borrowComm (in int tagsRequested, inout array< int > tagList, inout int key) throws gov.cca.CCAException
 Get a communicator of the port provider (in FORTRAN form).
void returnComm (in long comm, in int tagsRequested, inout array< int > tagList, in int key) throws gov.cca.CCAException
 Return a previously borrowed communicator and tag list.

Member Function Documentation

long gov.cca.ports.MPIBorrow.borrowComm ( in int  tagsRequested,
inout array< int >  tagList,
inout int  key 
) throws gov.cca.CCAException

Get a communicator of the port provider (in FORTRAN form).

This communicator will be the same instance as the comm of the port provider, with all the message collision potential that implies. For all but perhaps debugging purposes, this call must be made collectively. The use of a tagList is optional (tagsRequested can be 0), in which case no guarantees can be provided about tag conflicts.

Parameters:
tagCount,:The number of tags the borrower wishes to use all to itself.
tagList,:Array to be filled with tags available. The array given as input must be at least tagCount long. The values of the tags returned are arbitrary, so if the user wishes the value of a tag to encode additional information, this port is not for that user.
key,:key to be returned when the tags and comm are done with.
Returns:
The comm being borrowed, in FORTRAN form. C callers use comm_f2c method defined by their mpi implementation, usually MPI_Comm_f2c, to convert result to MPI_Comm.
Exceptions:
CCAExceptionif the service cannot be implemented because MPI is not present.
void gov.cca.ports.MPIBorrow.returnComm ( in long  comm,
in int  tagsRequested,
inout array< int >  tagList,
in int  key 
) throws gov.cca.CCAException

Return a previously borrowed communicator and tag list.

For all but perhaps debugging purposes, this call must be made collectively.

Parameters:
tagCount,:The length of tagList.
tagList,:The tags being returned, at least tagCount long.
key,:The key obtained with borrowComm. It is an error to attempt to return tags that you didn't receive.
Exceptions:
CCAExceptionif an error is detected.

The documentation for this interface was generated from the following file: