ucxx::internal::RecvAmMessage Class Reference

Handle receiving of a ucxx::RequestAm. More...

#include <request_am.h>

Public Member Functions
	RecvAmMessage (const RecvAmMessage &)=delete
RecvAmMessage &	operator= (RecvAmMessage const &)=delete
	RecvAmMessage (RecvAmMessage &&o)=delete
RecvAmMessage &	operator= (RecvAmMessage &&o)=delete
	RecvAmMessage (internal::AmData *amData, ucp_ep_h ep, std::shared_ptr< RequestAm > request, std::shared_ptr< Buffer > buffer, AmReceiverCallbackType receiverCallback=AmReceiverCallbackType())
	Constructor of ucxx::RecvAmMessage. More...
void	setUcpRequest (void *request)
	Set the UCP request. More...
void	callback (void *request, ucs_status_t status)
	Execute the ucxx::Request::callback(). More...

Public Attributes
internal::AmData *	_amData {nullptr}
	Active messages data.
ucp_ep_h	_ep {nullptr}
	Handle containing address of the reply endpoint.
std::shared_ptr< RequestAm >	_request
	Request which will later be notified/delivered to user. More...
std::shared_ptr< Buffer >	_buffer {nullptr}
	Buffer containing the received data.

Detailed Description

Handle receiving of a ucxx::RequestAm.

Handle receiving of a ucxx::RequestAm, delivering the message to the user and notifying of completion.

Constructor & Destructor Documentation

RecvAmMessage()

ucxx::internal::RecvAmMessage::RecvAmMessage	(	internal::AmData *	amData,
		ucp_ep_h	ep,
		std::shared_ptr< RequestAm >	request,
		std::shared_ptr< Buffer >	buffer,
		AmReceiverCallbackType	receiverCallback = AmReceiverCallbackType()
	)

Constructor of ucxx::RecvAmMessage.

Construct the object, setting attributes that are later needed by the callback.

Parameters

[in]	amData	active messages worker data.
[in]	ep	handle containing address of the reply endpoint (i.e., endpoint where user is requesting to receive).
[in]	request	request to be later notified/delivered to user.
[in]	buffer	buffer containing the received data
[in]	receiverCallback	receiver callback to execute when request completes.

Member Function Documentation

callback()

void ucxx::internal::RecvAmMessage::callback	(	void *	request,
		ucs_status_t	status
	)

Execute the ucxx::Request::callback().

Execute the ucxx::Request::callback() method to set the status of the request, the buffer containing the data received and release the reference to this object from AmData.

Parameters

[in]	request	the UCP request associated to the active message receive operation.
[in]	status	the completion status of the UCP request.

setUcpRequest()

void ucxx::internal::RecvAmMessage::setUcpRequest

(

void *

request

)

Set the UCP request.

Set the underlying UCP request (_request attribute) of the RequestAm.

Parameters

[in]

request

the UCP request associated to the active message receive operation.

Member Data Documentation

_request

std::shared_ptr<RequestAm> ucxx::internal::RecvAmMessage::_request

Initial value:

{
    nullptr}

Request which will later be notified/delivered to user.

---

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

• /__w/ucxx/ucxx/cpp/include/ucxx/internal/request_am.h