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

#include <tag_probe_builder.h>

Public Member Functions
	TagProbeInfoBuilder ()
	Constructor for an unmatched `TagProbeInfoBuilder`.

	TagProbeInfoBuilder (const ucp_tag_recv_info_t &info, ucp_tag_message_h handle)
	Constructor for a matched `TagProbeInfoBuilder`. More...

	~TagProbeInfoBuilder ()
	`TagProbeInfoBuilder` destructor.

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

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

	TagProbeInfoBuilder (TagProbeInfoBuilder &&) noexcept
	Move constructor.

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

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

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

Detailed Description

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

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

Constructor & Destructor Documentation

◆ TagProbeInfoBuilder()

ucxx::TagProbeInfoBuilder::TagProbeInfoBuilder	(	const ucp_tag_recv_info_t &	info,
		ucp_tag_message_h	handle
	)

Constructor for a matched TagProbeInfoBuilder.

Parameters

[in]	info	UCP tag receive info.
[in]	handle	UCP tag message handle.

Member Function Documentation

◆ build()

std::shared_ptr<TagProbeInfo> ucxx::TagProbeInfoBuilder::build ( )

Build and return the TagProbeInfo.

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

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

◆ operator std::shared_ptr< TagProbeInfo >()

ucxx::TagProbeInfoBuilder::operator std::shared_ptr< TagProbeInfo > ( )

Implicit conversion operator to shared_ptr<TagProbeInfo>.

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

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