![]() |
Home | Libraries | People | FAQ | More |
boost::mpi::status — Contains information about a message that has been or can be received.
// In header: <boost/mpi/status.hpp> class status { public: // construct/copy/destruct (); (); // public member functions () ; () ; () ; () ; template<typename T> () ; (); () ; // public data members mutable m_count; };
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.
status
public member functions() ;
Retrieve the source of the message.
() ;
Retrieve the message tag.
() ;
Retrieve the error code.
() ;
Determine whether the communication associated with this object has been successfully cancelled.
template<typename T> () ;
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 |
();
References the underlying MPI_Status
() ;
References the underlying MPI_Status