Encapsulation of the result of a receive (blocking or nonblocking). More...

#include <Teuchos_Comm.hpp>

Inheritance diagram for Teuchos::CommStatus< OrdinalType >:

Public Member Functions
virtual	~CommStatus ()
	Destructor (declared virtual for memory safety)
virtual OrdinalType	getSourceRank ()=0
	The source rank that sent the message.
virtual OrdinalType	getTag ()=0
	The tag of the received message.

Detailed Description

template<class OrdinalType>
class Teuchos::CommStatus< OrdinalType >

Encapsulation of the result of a receive (blocking or nonblocking).

An instance of this class encapsulates the result of a receive. (An MPI implementation would wrap MPI_Status.) You can query it for information like the rank of the process that sent you the message. (This is useful if your receive specified a negative source rank, indicating that you would accept a message from any process in the communicator.)

Template Parameters:

OrdinalType The same template parameter as Comm. Only use int here. We only make this a template class for compatibility with Comm.

Note:: For now, this class only exposes the rank of the process that sent the message (the "source rank") and its tag. Later, we might expose other fields of MPI_Status in this interface. For now, you can attempt a dynamic cast to MpiCommStatus to access all three fields (MPI_SOURCE, MPI_TAG, and MPI_ERROR).

Definition at line 71 of file Teuchos_Comm.hpp.