|
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...
|
|
◆ memGetCallback()
static void ucxx::RequestMem::memGetCallback |
( |
void * |
request, |
|
|
ucs_status_t |
status, |
|
|
void * |
arg |
|
) |
| |
|
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.
- Parameters
-
[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() . |
◆ memPutCallback()
static void ucxx::RequestMem::memPutCallback |
( |
void * |
request, |
|
|
ucs_status_t |
status, |
|
|
void * |
arg |
|
) |
| |
|
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.
- Parameters
-
[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() . |
◆ populateDelayedSubmission()
virtual void ucxx::RequestMem::populateDelayedSubmission |
( |
| ) |
|
|
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.
◆ request()
void ucxx::RequestMem::request |
( |
| ) |
|
◆ createRequestMem
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.
- Exceptions
-
- Parameters
-
[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 . |
- Returns
- The
shared_ptr<ucxx::RequestTag>
object
The documentation for this class was generated from the following file: