Data for an Active Message send. More...

#include <request_data.h>

Public Member Functions
	AmSend (const decltype(_buffer) buffer, const decltype(_length) length, const AmSendParams ¶ms=AmSendParams{})
	Constructor for Active Message-specific send data. More...

	AmSend (decltype(_iov) iov, const AmSendParams ¶ms=AmSendParams{})
	Constructor for Active Message-specific send data using IOV datatype. More...

Public Attributes
const void *const	_buffer {nullptr}
	The raw pointer where data to be sent is stored.

const size_t	_length {0}
	Message length in bytes (contiguous datatype only).

const std::vector< ucp_dt_iov_t >	_iov {}
	Segments for IOV datatype.

const size_t	_count {0}

const uint32_t	_flags {UCP_AM_SEND_FLAG_REPLY}
	UCP AM send flags.

const ucp_datatype_t	_datatype {ucp_dt_make_contig(1)}
	UCP datatype.

const ucs_memory_type_t	_memoryType {UCS_MEMORY_TYPE_HOST}
	Memory type used on the operation.

const AmSendMemoryTypePolicy	_memoryTypePolicy
	Receiver allocation policy. More...

const std::optional< AmReceiverCallbackInfo >	_receiverCallbackInfo
	Owner name and unique identifier of the receiver callback. More...

const std::vector< std::byte >	_userHeader {}
	Opaque user-defined header bytes.

Detailed Description

Data for an Active Message send.

Type identifying an Active Message send operation and containing data specific to this request type.

Constructor & Destructor Documentation

◆ AmSend() [1/2]

ucxx::data::AmSend::AmSend	(	const decltype(_buffer)	buffer,
		const decltype(_length)	length,
		const AmSendParams &	params = `AmSendParams{}`
	)

explicit

Constructor for Active Message-specific send data.

Construct an object containing Active Message-specific send data.

Parameters

[in]	buffer	a raw pointer to the data to be sent.
[in]	length	the size in bytes of the message to be sent.
[in]	params	send parameters controlling datatype/flags/policies.

◆ AmSend() [2/2]

ucxx::data::AmSend::AmSend	(	decltype(_iov)	iov,
		const AmSendParams &	params = `AmSendParams{}`
	)

explicit

Constructor for Active Message-specific send data using IOV datatype.

Construct an object containing Active Message-specific send data for UCP_DATATYPE_IOV.

Parameters

[in]	iov	vector of IOV segments to send.
[in]	params	send parameters controlling datatype/flags/policies.

Member Data Documentation

◆ _count

const size_t ucxx::data::AmSend::_count {0}

Count passed to ucp_am_send_nbx: byte count for contiguous, number of IOV segments for IOV.

◆ _memoryTypePolicy

const AmSendMemoryTypePolicy ucxx::data::AmSend::_memoryTypePolicy

Initial value:

{

AmSendMemoryTypePolicy::FallbackToHost}

ucxx::AmSendMemoryTypePolicy::FallbackToHost

@ FallbackToHost

If no allocator exists for memory type, fallback to host memory.

Receiver allocation policy.

◆ _receiverCallbackInfo

const std::optional<AmReceiverCallbackInfo> ucxx::data::AmSend::_receiverCallbackInfo

Initial value:

{

std::nullopt}

Owner name and unique identifier of the receiver callback.

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

/__w/ucxx/ucxx/cpp/include/ucxx/request_data.h

Public Member Functions

Public Attributes