Public Member Functions | |
| virtual void | populateDelayedSubmission () |
| Populate the internal submission dispatcher. More... | |
| void | request () |
| Create and submit a memory get or put request. More... | |
 Public Member Functions inherited from ucxx::Request | |
| Request (const Request &)=delete | |
| Request & | operator= (Request const &)=delete |
| Request (Request &&o)=delete | |
| Request & | operator= (Request &&o)=delete |
| virtual | ~Request () |
ucxx::Request destructor. More... | |
| virtual void | cancel () |
| Cancel the request. More... | |
| ucs_status_t | getStatus () |
| Return the status of the request. More... | |
| void * | getFuture () |
| Return the future used to check on state. More... | |
| void | checkError () |
| Check whether the request completed with an error. More... | |
| bool | isCompleted () |
| Check whether the request has already completed. More... | |
| void | callback (void *request, ucs_status_t status) |
| Callback executed by UCX when request is completed. More... | |
| const std::string & | getOwnerString () const |
| Get formatted string with owner type and handle address. More... | |
| virtual std::shared_ptr< Buffer > | getRecvBuffer () |
| Get the received buffer. More... | |
| Public Member Functions inherited from ucxx::Component | |
| void | setParent (std::shared_ptr< Component > parent) |
| Set the internal parent reference. More... | |
| std::shared_ptr< Component > | getParent () const |
| Get the internal parent reference. More... | |
Static Public Member Functions | |
| static void | memPutCallback (void *request, ucs_status_t status, void *arg) |
| Callback executed by UCX when a memory put request is completed. More... | |
| static void | memGetCallback (void *request, ucs_status_t status, void *arg) |
| Callback executed by UCX when a memory get request is completed. More... | |
Friends | |
| class | internal::RecvMemMessage |
| std::shared_ptr< RequestMem > | createRequestMem (std::shared_ptr< Endpoint > endpoint, const std::variant< data::MemPut, data::MemGet > requestData, const bool enablePythonFuture, RequestCallbackUserFunction callbackFunction, RequestCallbackUserData callbackData) |
Constructor for std::shared_ptr<ucxx::RequestMem>. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ucxx::Request | |
| Request (std::shared_ptr< Component > endpointOrWorker, const data::RequestData requestData, const std::string operationName, const bool enablePythonFuture=false, RequestCallbackUserFunction callbackFunction=nullptr, RequestCallbackUserData callbackData=nullptr) | |
Protected constructor of an abstract ucxx::Request. More... | |
| void | process () |
| Perform initial processing of the request to determine if immediate completion. More... | |
| void | setStatus (ucs_status_t status) |
| Set the request status and notify Python future. More... | |
| Protected Attributes inherited from ucxx::Request | |
| ucs_status_t | _status {UCS_INPROGRESS} |
| Requests status. | |
| std::string | _status_msg {} |
| Human-readable status message. | |
| void * | _request {nullptr} |
| Pointer to UCP request. | |
| std::shared_ptr< Future > | _future {nullptr} |
| Future to notify upon completion. | |
| std::shared_ptr< Worker > | _worker |
| Worker that generated request (if not from endpoint) More... | |
| std::shared_ptr< Endpoint > | _endpoint |
| Endpoint that generated request (if not from worker) More... | |
| std::string | _ownerString |
| String to print owner (endpoint or worker) when logging. More... | |
| std::recursive_mutex | _mutex {} |
| Mutex to prevent checking status while it's being set. | |
| data::RequestData | _requestData {} |
| The operation-specific data to be used in the request. | |
| std::string | _operationName |
| Human-readable operation name, mostly used for log messages. More... | |
| bool | _enablePythonFuture {true} |
| Whether Python future is enabled for this request. | |
| RequestCallbackUserFunction | _callback {nullptr} |
| Completion callback. | |
| RequestCallbackUserData | _callbackData {nullptr} |
| Completion callback data. | |
| Protected Attributes inherited from ucxx::Component | |
| std::shared_ptr< Component > | _parent {nullptr} |
| A reference-counted pointer to the parent. | |
|
static |
Callback executed by UCX when a memory get request is completed.
Callback executed by UCX when a memory get request is completed, that will dispatch ucxx::Request::callback().
WARNING: This is not intended to be called by the user, but it currently needs to be a public method so that UCX may access it. In future changes this will be moved to an internal object and remove this method from the public API.
| [in] | request | the UCX request pointer. |
| [in] | status | the completion status of the request. |
| [in] | arg | the pointer to the ucxx::Request object that created the transfer, effectively this pointer as seen by request(). |
|
static |
Callback executed by UCX when a memory put request is completed.
Callback executed by UCX when a memory put request is completed, that will dispatch ucxx::Request::callback().
WARNING: This is not intended to be called by the user, but it currently needs to be a public method so that UCX may access it. In future changes this will be moved to an internal object and remove this method from the public API.
| [in] | request | the UCX request pointer. |
| [in] | status | the completion status of the request. |
| [in] | arg | the pointer to the ucxx::Request object that created the transfer, effectively this pointer as seen by request(). |
|
virtual |
Populate the internal submission dispatcher.
The ucxx::Request utilizes ucxx::DelayedSubmission to manage when the request will be dispatched. This method is registered as a callback in the worker, that may choose to either execute (submit) it immediately or delay for the next iteration of its progress loop, depending on the progress mode in use by the worker.
See ucxx::DelayedSubmission::DelayedSubmission() for more details.
Implements ucxx::Request.
| void ucxx::RequestMem::request | ( | ) |
Create and submit a memory get or put request.
This is the method that should be called to actually submit memory request get or put request. It is meant to be called from populateDelayedSubmission(), which is decided at the discretion of std::shared_ptr<ucxx::Worker>. See populateDelayedSubmission() for more details.
|
friend |
Constructor for std::shared_ptr<ucxx::RequestMem>.
The constructor for a std::shared_ptr<ucxx::RequestMem> object, creating a get or put request, returning a pointer to a request object that can be later awaited and checked for errors. This is a non-blocking operation, and the status of the transfer must be verified from the resulting request object before both the local and remote data can be released and the local data (on get operations) or remote data (on put operations) can be consumed.
| ucxx::Error | if endpointOrWorker is not a valid std::shared_ptr<ucxx::Endpoint> or std::shared_ptr<ucxx::Worker>. |
| [in] | endpointOrWorker | the parent component, which may either be a std::shared_ptr<Endpoint> or std::shared_ptr<Worker>. |
| [in] | requestData | container of the specified message type, including all type-specific data. |
| [in] | enablePythonFuture | whether a python future should be created and subsequently notified. |
| [in] | callbackFunction | user-defined callback function to call upon completion. |
| [in] | callbackData | user-defined data to pass to the callbackFunction. |
shared_ptr<ucxx::RequestTag> object 
1.9.1