classic::gov::cca::MPIBorrow Class Reference

UNADOPTED standard service. More...

#include <MPIBorrow.h>

Inheritance diagram for classic::gov::cca::MPIBorrow:

[legend]

Collaboration diagram for classic::gov::cca::MPIBorrow:

[legend]

List of all members.

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	(	int	tagCount,
		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:

	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 classic::gov::cca::MPIBorrow::returnComm	(	MPI_Comm	,
		int	tagCount,
		int *	tagList,
		int	key
	)			[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:

• MPIBorrow.h