All Classes Namespaces Functions Variables Typedefs Enumerations Friends
request_tag.h
1 
5 #pragma once
6 #include <memory>
7 #include <string>
8 #include <utility>
9 
10 #include <ucp/api/ucp.h>
11 
12 #include <ucxx/delayed_submission.h>
13 #include <ucxx/request.h>
14 #include <ucxx/typedefs.h>
15 
16 namespace ucxx {
17 
24 class RequestTag : public Request {
25  private:
55  RequestTag(std::shared_ptr<Component> endpointOrWorker,
56  const std::variant<data::TagSend, data::TagReceive> requestData,
57  const std::string operationName,
58  const bool enablePythonFuture = false,
59  RequestCallbackUserFunction callbackFunction = nullptr,
60  RequestCallbackUserData callbackData = nullptr);
61 
62  public:
87  [[nodiscard]] friend std::shared_ptr<RequestTag> createRequestTag(
88  std::shared_ptr<Component> endpointOrWorker,
89  const std::variant<data::TagSend, data::TagReceive> requestData,
90  const bool enablePythonFuture,
91  RequestCallbackUserFunction callbackFunction,
92  RequestCallbackUserData callbackData);
93 
94  virtual void populateDelayedSubmission();
95 
103  void request();
104 
120  static void tagSendCallback(void* request, ucs_status_t status, void* arg);
121 
139  static void tagRecvCallback(void* request,
140  ucs_status_t status,
141  const ucp_tag_recv_info_t* info,
142  void* arg);
143 
160  void callback(void* request, ucs_status_t status, const ucp_tag_recv_info_t* info);
161 };
162 
163 } // namespace ucxx
Send or receive a message with the UCX Tag API.
Definition: request_tag.h:24
void request()
Create and submit a tag request.
virtual void populateDelayedSubmission()
Populate the internal submission dispatcher.
friend std::shared_ptr< RequestTag > createRequestTag(std::shared_ptr< Component > endpointOrWorker, const std::variant< data::TagSend, data::TagReceive > requestData, const bool enablePythonFuture, RequestCallbackUserFunction callbackFunction, RequestCallbackUserData callbackData)
Constructor for std::shared_ptr<ucxx::RequestTag>.
void callback(void *request, ucs_status_t status, const ucp_tag_recv_info_t *info)
Implementation of the tag receive request callback.
static void tagSendCallback(void *request, ucs_status_t status, void *arg)
Callback executed by UCX when a tag send request is completed.
static void tagRecvCallback(void *request, ucs_status_t status, const ucp_tag_recv_info_t *info, void *arg)
Callback executed by UCX when a tag receive request is completed.
Base type for a UCXX transfer request.
Definition: request.h:38
Definition: address.h:15
std::function< void(ucs_status_t, std::shared_ptr< void >)> RequestCallbackUserFunction
A user-defined function to execute as part of a ucxx::Request callback.
Definition: typedefs.h:89
std::shared_ptr< void > RequestCallbackUserData
Data for the user-defined function provided to the ucxx::Request callback.
Definition: typedefs.h:97