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

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

#include <ucxx.hpp>

Inheritance diagram for rapidsmpf::ucxx::UCXX::Future:
rapidsmpf::Communicator::Future

Public Member Functions

 Future (std::shared_ptr<::ucxx::Request > req, std::unique_ptr< Buffer > data_buffer)
 Construct a Future from a data buffer. More...
 
 Future (std::shared_ptr<::ucxx::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 UCXX
 

Detailed Description

Represents the future result of an UCXX operation.

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

Definition at line 119 of file ucxx.hpp.

Constructor & Destructor Documentation

◆ Future() [1/2]

rapidsmpf::ucxx::UCXX::Future::Future ( std::shared_ptr<::ucxx::Request >  req,
std::unique_ptr< Buffer data_buffer 
)
inline

Construct a Future from a data buffer.

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

Definition at line 129 of file ucxx.hpp.

◆ Future() [2/2]

rapidsmpf::ucxx::UCXX::Future::Future ( std::shared_ptr<::ucxx::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 UCXX operations where the data resides in host memory and is guaranteed to be valid at the time of the call.

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

Definition at line 141 of file ucxx.hpp.


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