Tpetra::Details::CommRequest Class Reference

Base class for the request (more or less a future) representing a pending nonblocking MPI operation. More...

#include <Tpetra_Details_iallreduce.hpp>

Inheritance diagram for Tpetra::Details::CommRequest:

Public Member Functions
virtual	~CommRequest ()
	Destructor (virtual for memory safety of derived classes). More...
virtual void	wait ()=0
	Wait on this communication request to complete. More...
virtual void	cancel ()=0
	Cancel the pending communication request. More...

Detailed Description

Base class for the request (more or less a future) representing a pending nonblocking MPI operation.

We recommend using auto to interact with this class. For example, use auto for the type of the return value of iallreduce() (see below).

Definition at line 89 of file Tpetra_Details_iallreduce.hpp.

Constructor & Destructor Documentation

virtual Tpetra::Details::CommRequest::~CommRequest ( )

inlinevirtual

Destructor (virtual for memory safety of derived classes).

Definition at line 92 of file Tpetra_Details_iallreduce.hpp.

Member Function Documentation

virtual void Tpetra::Details::CommRequest::wait ( )

pure virtual

Wait on this communication request to complete.

This is a blocking operation. The user is responsible for avoiding deadlock. This operation must also be idempotent.

Implemented in Tpetra::Details::Impl::IallreduceCommRequest< PacketType, SendLayoutType, SendDeviceType, RecvLayoutType, RecvDeviceType, 0 >, Tpetra::Details::Impl::IallreduceCommRequest< PacketType, SendLayoutType, SendDeviceType, RecvLayoutType, RecvDeviceType, 1 >, and Tpetra::Details::Impl::DeferredActionCommRequest.

virtual void Tpetra::Details::CommRequest::cancel ( )

pure virtual

Cancel the pending communication request.

This operation must be idempotent.

Implemented in Tpetra::Details::Impl::IallreduceCommRequest< PacketType, SendLayoutType, SendDeviceType, RecvLayoutType, RecvDeviceType, 0 >, Tpetra::Details::Impl::IallreduceCommRequest< PacketType, SendLayoutType, SendDeviceType, RecvLayoutType, RecvDeviceType, 1 >, and Tpetra::Details::Impl::DeferredActionCommRequest.

---

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

• Tpetra_Details_iallreduce.hpp