UCX++
Public Member Functions | List of all members
ucxpp::remote_address Class Reference

Represents a remote UCX address. More...

#include <ucxpp/address.h>

Public Member Functions

 remote_address (std::vector< char > const &address)
 Construct a new remote address object. More...
 
 remote_address (std::vector< char > &&address)
 Construct a new remote address object. More...
 
 remote_address (remote_address &&other)=default
 Move construct a new remote address object. More...
 
 remote_address (remote_address const &other)=default
 Construct a new remote address object. More...
 
remote_addressoperator= (remote_address const &other)=default
 Copy assignment operator. More...
 
remote_addressoperator= (remote_address &&other)=default
 Move assignment operator. More...
 
const ucp_address_t * get_address () const
 Get the UCP address. More...
 
size_t get_length () const
 Get the length of the address. More...
 

Detailed Description

Represents a remote UCX address.

Constructor & Destructor Documentation

◆ remote_address() [1/4]

ucxpp::remote_address::remote_address ( std::vector< char > const &  address)

Construct a new remote address object.

Parameters
addressThe received address buffer

◆ remote_address() [2/4]

ucxpp::remote_address::remote_address ( std::vector< char > &&  address)

Construct a new remote address object.

Parameters
addressAnother remote address object to move from

◆ remote_address() [3/4]

ucxpp::remote_address::remote_address ( remote_address &&  other)
default

Move construct a new remote address object.

Parameters
otherAnother remote address object to move from

◆ remote_address() [4/4]

ucxpp::remote_address::remote_address ( remote_address const &  other)
default

Construct a new remote address object.

Parameters
otherAnother remote address object to copy from

Member Function Documentation

◆ get_address()

const ucp_address_t * ucxpp::remote_address::get_address ( ) const

Get the UCP address.

Returns
const ucp_address_t* The UCP address

◆ get_length()

size_t ucxpp::remote_address::get_length ( ) const

Get the length of the address.

Returns
size_t The length of the address

◆ operator=() [1/2]

remote_address & ucxpp::remote_address::operator= ( remote_address &&  other)
default

Move assignment operator.

Parameters
otherAnother remote address object to move from
Returns
remote_address& This object

◆ operator=() [2/2]

remote_address & ucxpp::remote_address::operator= ( remote_address const &  other)
default

Copy assignment operator.

Parameters
otherAnother remote address object to copy from
Returns
remote_address& This object

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