Wrapper for MPI request handles (aka. MPI_Request). More...

#include <request.hpp>

Inheritance diagram for kamping::Request:

Public Member Functions
	Request (MPI_Request request=MPI_REQUEST_NULL)
	Constructs a request handle from an `MPI_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.

Public Member Functions inherited from kamping::RequestBase< Request >
	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

Wrapper for MPI request handles (aka. MPI_Request).

Constructor & Destructor Documentation

kamping::Request::Request ( MPI_Request request = MPI_REQUEST_NULL )

inline

Constructs a request handle from an MPI_Request.

Parameters

request The request to encapsulate. Defaults to MPI_REQUEST_NULL.

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