Builder class for constructing std::shared_ptr<ucxx::RemoteKey> objects. More...

#include <remote_key_builder.h>

Public Member Functions
	RemoteKeyBuilder (std::shared_ptr< MemoryHandle > memoryHandle)
	Constructor for `RemoteKeyBuilder` from a local memory handle. More...

	RemoteKeyBuilder (std::shared_ptr< Endpoint > endpoint, SerializedRemoteKey serializedRemoteKey)
	Constructor for `RemoteKeyBuilder` from a serialized remote key. More...

	~RemoteKeyBuilder ()
	`RemoteKeyBuilder` destructor.

	RemoteKeyBuilder (const RemoteKeyBuilder &other)
	Copy constructor (deep-copies internal state).

RemoteKeyBuilder &	operator= (const RemoteKeyBuilder &other)
	Copy assignment operator (deep-copies internal state).

	RemoteKeyBuilder (RemoteKeyBuilder &&) noexcept
	Move constructor.

RemoteKeyBuilder &	operator= (RemoteKeyBuilder &&) noexcept
	Move assignment operator.

	operator std::shared_ptr< RemoteKey > ()
	Implicit conversion operator to `shared_ptr<RemoteKey>`. More...

std::shared_ptr< RemoteKey >	build ()
	Build and return the `RemoteKey`. More...

Detailed Description

Builder class for constructing std::shared_ptr<ucxx::RemoteKey> objects.

This class implements the builder pattern for std::shared_ptr<ucxx::RemoteKey>. Construction happens when build() is called or when the builder is implicitly converted to std::shared_ptr<RemoteKey>.

Constructor & Destructor Documentation

◆ RemoteKeyBuilder() [1/2]

ucxx::RemoteKeyBuilder::RemoteKeyBuilder ( std::shared_ptr< MemoryHandle > memoryHandle )

explicit

Constructor for RemoteKeyBuilder from a local memory handle.

Parameters

[in] memoryHandle local memory handle to pack.

◆ RemoteKeyBuilder() [2/2]

ucxx::RemoteKeyBuilder::RemoteKeyBuilder	(	std::shared_ptr< Endpoint >	endpoint,
		SerializedRemoteKey	serializedRemoteKey
	)

Constructor for RemoteKeyBuilder from a serialized remote key.

Parameters

[in]	endpoint	endpoint used to unpack the remote key.
[in]	serializedRemoteKey	serialized remote key data.

Member Function Documentation

◆ build()

std::shared_ptr<RemoteKey> ucxx::RemoteKeyBuilder::build ( )

Build and return the RemoteKey.

Each call to build() creates a new RemoteKey instance with the current parameters.

Returns: The constructed shared_ptr<ucxx::RemoteKey> object.

◆ operator std::shared_ptr< RemoteKey >()

ucxx::RemoteKeyBuilder::operator std::shared_ptr< RemoteKey > ( )

Implicit conversion operator to shared_ptr<RemoteKey>.

Returns: The constructed shared_ptr<ucxx::RemoteKey> object.

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

/__w/ucxx/ucxx/cpp/include/ucxx/remote_key_builder.h