rti::core::Locator Class Reference

<<extension>> <<value-type>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...

#include "rti/core/Locator.hpp"

Public Member Functions
	Locator (const rti::core::LocatorKind::type the_kind, uint32_t the_port, const dds::core::ByteSeq &the_address)
	Construct a Locator with the provided kind, port and address.
rti::core::LocatorKind::type	kind () const
	Get the kind associated with this Locator.
Locator &	kind (const rti::core::LocatorKind::type the_kind)
	Set the kind associated with this Locator.
uint32_t	port () const
	Get the port number associated with this Locator.
Locator &	port (uint32_t the_port)
	Set the port number associated with this Locator.
dds::core::ByteSeq	address () const
	Get the IP address associated with this Locator.
Locator &	address (const dds::core::ByteSeq &the_address)
	Set the address associated with this Locator object.

Static Public Member Functions
static Locator	Invalid ()
	Construct an invalid locator.

Related Functions
(Note that these are not member functions.)
typedef std::vector< Locator >	LocatorSeq
	A sequence of rti::core::Locator.

Detailed Description

<<extension>> <<value-type>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports.

Constructor & Destructor Documentation

rti::core::Locator::Locator ( const rti::core::LocatorKind::type  the_kind, uint32_t  the_port, const dds::core::ByteSeq &  the_address  )

inline

Construct a Locator with the provided kind, port and address.

Member Function Documentation

rti::core::LocatorKind::type rti::core::Locator::kind ( ) const

inline

Get the kind associated with this Locator.

The kind of locator.

If the Locator_t kind is Locator_t::KIND_UDPv4, the address contains an IPv4 address. In this case, the leading 12 octets of the Locator_t::address must be zero. The last 4 octets of Locator_t::address are used to store the IPv4 address.

If the Locator_t kind is Locator_t::KIND_UDPv6, the address contains an IPv6 address. IPv6 addresses typically use a shorthand hexadecimal notation that maps one-to-one to the 16 octets in the Locator_t::address field.

See Also

rti::core::LocatorKind_def

Locator& rti::core::Locator::kind ( const rti::core::LocatorKind::type  the_kind )

inline

Set the kind associated with this Locator.

See Also

rti::core::LocatorKind_def

uint32_t rti::core::Locator::port ( ) const

inline

Get the port number associated with this Locator.

Locator& rti::core::Locator::port ( uint32_t  the_port )

inline

Set the port number associated with this Locator.

dds::core::ByteSeq rti::core::Locator::address ( ) const

inline

Get the IP address associated with this Locator.

Locator& rti::core::Locator::address ( const dds::core::ByteSeq &  the_address )

inline

Set the address associated with this Locator object.

static Locator rti::core::Locator::Invalid ( )

inlinestatic

Construct an invalid locator.

Since this class doesn't provide a default constructor if you don't know the values of a Locator at the moment of construction use this function explicitly to obtain an invalid object to be filled out.

Friends And Related Function Documentation

typedef std::vector<Locator> LocatorSeq

related

A sequence of rti::core::Locator.