boost::mpi::status Class Reference

Contains information about a message that has been or can be received. More...

#include <status.hpp>

Public Member Functions
	status ()
	status (MPI_Status const &s)
int	source () const
	Retrieve the source of the message. More...
int	tag () const
	Retrieve the message tag. More...
int	error () const
	Retrieve the error code. More...
bool	cancelled () const
	Determine whether the communication associated with this object has been successfully cancelled. More...
template<typename T >
optional< int >	count () const
	Determines the number of elements of type T contained in the message. More...
	operator MPI_Status & ()
	References the underlying MPI_Status. More...
	operator const MPI_Status & () const
	References the underlying MPI_Status. More...

Public Attributes
MPI_Status	m_status
	INTERNAL ONLY. More...
int	m_count

Friends
class	communicator
class	request

Detailed Description

Contains information about a message that has been or can be received.

This structure contains status information about messages that have been received (with communicator::recv) or can be received (returned from communicator::probe or communicator::iprobe). It permits access to the source of the message, message tag, error code (rarely used), or the number of elements that have been transmitted.

Constructor & Destructor Documentation

boost::mpi::status::status ( )

inline

boost::mpi::status::status ( MPI_Status const &  s )

inline

Member Function Documentation

bool boost::mpi::status::cancelled

(

)

const

Determine whether the communication associated with this object has been successfully cancelled.

template<typename T >

optional< int > boost::mpi::status::count ( ) const

inline

Determines the number of elements of type T contained in the message.

The type T must have an associated data type, i.e., is_mpi_datatype<T> must derive mpl::true_. In cases where the type T does not match the transmitted type, this routine will return an empty optional<int>.

Returns

the number of T elements in the message, if it can be determined.

int boost::mpi::status::error ( ) const

inline

Retrieve the error code.

boost::mpi::status::operator const MPI_Status & ( ) const

inline

References the underlying MPI_Status.

boost::mpi::status::operator MPI_Status & ( )

inline

References the underlying MPI_Status.

int boost::mpi::status::source ( ) const

inline

Retrieve the source of the message.

int boost::mpi::status::tag ( ) const

inline

Retrieve the message tag.

Friends And Related Function Documentation

friend class communicator

friend

friend class request

friend

Member Data Documentation

int boost::mpi::status::m_count

mutable

Referenced by boost::mpi::communicator::array_recv_impl(), boost::mpi::detail::serialized_irecv_data< T >::deserialize(), and boost::mpi::detail::serialized_array_irecv_data< T >::deserialize().

MPI_Status boost::mpi::status::m_status

mutable

INTERNAL ONLY.

Referenced by boost::mpi::communicator::array_recv_impl(), boost::mpi::communicator::recv_impl(), boost::mpi::test_all(), boost::mpi::wait_all(), boost::mpi::wait_any(), and boost::mpi::wait_some().

---

The documentation for this class was generated from the following files:

• boost_1_57_0/boost/mpi/status.hpp
• boost_1_57_0/boost/mpi/communicator.hpp