17.2.3.9.4. Locator_t

class eprosima::fastrtps::rtps::Locator_t

Class Locator_t, uniquely identifies a communication channel for a particular transport. For example, an address + port combination in the case of UDP.

Public Functions

inline Locator_t()

Default constructor.

inline Locator_t(Locator_t &&loc)

Move constructor.

inline Locator_t(const Locator_t &loc)

Copy constructor.

inline Locator_t(uint32_t portin)

Port constructor.

inline Locator_t(int32_t kindin, uint32_t portin)

Kind and port constructor.

inline Locator_t &operator=(const Locator_t &loc)

Copy assignment.

inline bool set_address(const Locator_t &other)

Set the locator IP address using another locator.

Parameters

other – Locator which IP address is used to set this locator IP address.

Returns

always true.

inline octet *get_address()

Getter for the locator IP address.

Returns

IP address as octet pointer.

inline octet get_address(uint16_t field) const

Getter for a specific field of the locator IP address.

Parameters

field – IP address element to be accessed.

Returns

Octet value for the specific IP address element.

inline void set_Invalid_Address()

Automatic setter for setting locator IP address to invalid address (0).

Public Members

int32_t kind

Specifies the locator type. Valid values are:

LOCATOR_KIND_UDPv4

LOCATOR_KIND_UDPv6

LOCATOR_KIND_TCPv4

LOCATOR_KIND_TCPv6

LOCATOR_KIND_SHM

uint32_t port

Network port.

octet address[16]

IP address.