Wrapper for MPI requests owned by a RequestPool. More...

#include <request.hpp>

Inheritance diagram for kamping::PooledRequest< IndexType >:

Collaboration diagram for kamping::PooledRequest< IndexType >:

Public Member Functions
	PooledRequest (IndexType idx, MPI_Request &request)
	constructs a PooledRequest with the given index `idx` and `request`.

MPI_Request *	request_ptr ()
	returns a pointer to the wrapped MPI_Request.

MPI_Request const *	request_ptr () const
	returns a const pointer to the wrapped MPI_Request.

IndexType	index () const
	provides access to this request's index in the pool.

Public Member Functions inherited from kamping::RequestBase< PooledRequest< IndexType > >
	RequestBase (RequestBase const &)=delete
	Copy constructor is deleted because requests should only be moved.

	RequestBase (RequestBase &&)=default
	Move constructor.

RequestBase &	operator= (RequestBase const &)=delete
	Copy assignment operator is deleted because requests should only be moved.

RequestBase &	operator= (RequestBase &&)=default
	Move assignment operator.

auto	wait (StatusParamObjectType status_param=kamping::status(ignore<>))
	Returns when the operation defined by the underlying request completes. If the underlying request was initialized by a non-blocking communication call, it is set to `MPI_REQUEST_NULL`.

bool	is_null () const

auto	test (StatusParamObjectType status_param=kamping::status(ignore<>))
	Tests for completion of the underlying request. If the underlying request was initialized by a non-blocking communication call and completes, it is set to `MPI_REQUEST_NULL`.

MPI_Request &	mpi_request ()

MPI_Request const &	mpi_request () const

bool	operator== (RequestBase< T > const &other) const

bool	operator!= (RequestBase< T > const &other) const

Detailed Description

template<typename IndexType>
class kamping::PooledRequest< IndexType >

Wrapper for MPI requests owned by a RequestPool.

Template Parameters

IndexType type of the index of this request in the pool.

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

include/kamping/request.hpp

Public Member Functions

Detailed Description