Represents a local UCX address. More...
#include <ucxpp/address.h>
Inheritance diagram for ucxpp::local_address:
Collaboration diagram for ucxpp::local_address:
Public Member Functions | |
| local_address (std::shared_ptr< worker const > worker, ucp_address_t *address, size_t address_length) | |
| Construct a new local address object. More... | |
| local_address (local_address &&other) | |
| Construct a new local address object. More... | |
| local_address & | operator= (local_address &&other) |
| Move assignment operator. More... | |
| std::vector< char > | serialize () const |
| Serialize the address to a buffer ready to be sent to a remote peer. 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... | |
| ~local_address () | |
| Destroy the local address object and release the buffer. | |
 Public Member Functions inherited from ucxpp::noncopyable | |
| noncopyable (noncopyable &&)=default | |
| noncopyable (noncopyable const &)=delete | |
| noncopyable & | operator= (noncopyable const &)=delete |
| noncopyable & | operator= (noncopyable &&)=default |
Friends | |
| class | endpoint |
Detailed Description
Represents a local UCX address.
Constructor & Destructor Documentation
◆ local_address() [1/2]
| ucxpp::local_address::local_address | ( | std::shared_ptr< worker const > | worker, |
| ucp_address_t * | address, | ||
| size_t | address_length | ||
| ) |
Construct a new local address object.
- Parameters
-
worker UCX worker address UCP address address_length UCP address length
◆ local_address() [2/2]
| ucxpp::local_address::local_address | ( | local_address && | other | ) |
Construct a new local address object.
- Parameters
-
other Another local address object to move from
Member Function Documentation
◆ get_address()
| const ucp_address_t * ucxpp::local_address::get_address | ( | ) | const |
Get the UCP address.
- Returns
- const ucp_address_t* The UCP address
◆ get_length()
| size_t ucxpp::local_address::get_length | ( | ) | const |
Get the length of the address.
- Returns
- size_t The address length
◆ operator=()
| local_address & ucxpp::local_address::operator= | ( | local_address && | other | ) |
Move assignment operator.
- Parameters
-
other Another local address object to move from
- Returns
- local_address& This object
◆ serialize()
| std::vector< char > ucxpp::local_address::serialize | ( | ) | const |
Serialize the address to a buffer ready to be sent to a remote peer.
- Returns
- std::vector<char> The serialized address
The documentation for this class was generated from the following files:
- include/ucxpp/address.h
- src/address.cc
