Public Member Functions | Friends | List of all members
rapidsmpf::MPI::Future Class Reference

Represents the future result of an MPI operation. More...

#include <mpi.hpp>

Inheritance diagram for rapidsmpf::MPI::Future:
rapidsmpf::Communicator::Future

Public Member Functions

 Future (MPI_Request req, std::unique_ptr< Buffer > data_buffer)
 Construct a Future from a data buffer. More...
 
 Future (MPI_Request req, std::unique_ptr< std::vector< uint8_t >> synced_host_data)
 Construct a Future from synchronized host data. More...
 
- Public Member Functions inherited from rapidsmpf::Communicator::Future
 Future (Future &&)=default
 Movable.
 
Futureoperator= (Future &&)=default
 Move assignment. More...
 
 Future (Future const &)=delete
 Not copyable.
 
Futureoperator= (Future const &)=delete
 Not copy-assignable.
 

Friends

class MPI
 

Detailed Description

Represents the future result of an MPI operation.

This class is used to handle the result of an MPI communication operation asynchronously.

Definition at line 80 of file mpi.hpp.

Constructor & Destructor Documentation

◆ Future() [1/2]

rapidsmpf::MPI::Future::Future ( MPI_Request  req,
std::unique_ptr< Buffer data_buffer 
)
inline

Construct a Future from a data buffer.

Parameters
reqThe MPI request handle for the operation.
data_bufferA unique pointer to the data buffer.

Definition at line 90 of file mpi.hpp.

◆ Future() [2/2]

rapidsmpf::MPI::Future::Future ( MPI_Request  req,
std::unique_ptr< std::vector< uint8_t >>  synced_host_data 
)
inline

Construct a Future from synchronized host data.

This constructor is used for MPI operations where the data resides in host memory and is guaranteed to be valid at the time of the call.

Parameters
reqThe MPI request handle for the operation.
synced_host_dataA unique pointer to a vector containing host memory.

Definition at line 102 of file mpi.hpp.


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