boost::mpi::request Class Reference

A request for a non-blocking send or receive. More...

#include <request.hpp>

Collaboration diagram for boost::mpi::request:

Public Member Functions
	request ()
	Constructs a NULL request. More...
status	wait ()
	Wait until the communication associated with this request has completed, then return a status object describing the communication. More...
optional< status >	test ()
	Determine whether the communication associated with this request has completed successfully. More...
void	cancel ()
	Cancel a pending communication, assuming it has not already been completed. More...

Public Attributes
MPI_Request	m_requests [2]
	INTERNAL ONLY. More...
handler_type	m_handler
	INTERNAL ONLY. More...
shared_ptr< void >	m_data
	INTERNAL ONLY. More...

Friends
class	communicator

Detailed Description

A request for a non-blocking send or receive.

This structure contains information about a non-blocking send or receive and will be returned from isend or irecv, respectively.

Constructor & Destructor Documentation

boost::mpi::request::request

(

)

Constructs a NULL request.

Member Function Documentation

void boost::mpi::request::cancel

(

)

Cancel a pending communication, assuming it has not already been completed.

optional<status> boost::mpi::request::test

(

)

Determine whether the communication associated with this request has completed successfully.

If so, returns the status object describing the communication. Otherwise, returns an empty optional<> to indicate that the communication has not completed yet. Note that once test() returns a status object, the request has completed and wait() should not be called.

status boost::mpi::request::wait

(

)

Wait until the communication associated with this request has completed, then return a status object describing the communication.

Friends And Related Function Documentation

friend class communicator

friend

Member Data Documentation

shared_ptr<void> boost::mpi::request::m_data

INTERNAL ONLY.

Referenced by boost::mpi::communicator::array_irecv_impl(), boost::mpi::communicator::array_isend_impl(), boost::mpi::communicator::irecv_impl(), and boost::mpi::communicator::isend_impl().

handler_type boost::mpi::request::m_handler

INTERNAL ONLY.

Referenced by boost::mpi::communicator::array_irecv_impl(), and boost::mpi::communicator::irecv_impl().

MPI_Request boost::mpi::request::m_requests[2]

INTERNAL ONLY.

Referenced by boost::mpi::communicator::array_irecv_impl(), boost::mpi::communicator::array_isend_impl(), boost::mpi::communicator::irecv_impl(), and boost::mpi::communicator::isend_impl().

---

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

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