Locator Class Reference

Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...

Inherits IEquatable< Locator >.

Public Member Functions
Locator	With (Action< LocatorBuilder > build)
	Creates a new Locator with a set of changes specified in an Action More...
override int	GetHashCode ()
	Gets the hash code More...
override bool	Equals (object other)
	Compares for equality More...
bool	Equals (Locator other)
	Compares for equality More...

Static Public Attributes
const int	InvalidKind
	Locator of this kind is invalid. More...
const uint	InvalidPort
	An invalid port. More...
const int	UdPv4Kind
	A locator for a UDPv4 address. More...
const int	UdPv4WanKind
	A locator for a UDPv4 WAN address. More...
const int	ShmemKind
	A locator for an address accessed via shared memory. More...
const int	Shmem510Kind
	A locator for an address accessed via shared memory for RTI Connext 5.1.0 and earlier. More...
const int	UdPv6Kind
	A locator for a UDPv6 address. More...
const int	UdPv6510Kind
	A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier. More...
const int	ReservedKind
	Locator of this kind is reserved. More...

Properties
static Locator	LocatorInvalid [get]
	An invalid locator. More...
static ImmutableList< byte >	InvalidAddress [get]
	An invalid address. More...
int	Kind [get]
	The kind of locator. More...
uint	Port [get]
	The port number. More...
ImmutableList< byte >	Address [get]
	The IP address. More...
static Locator	Default [get]
	Singleton containing the default value of a Locator More...

Detailed Description

Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports.

The full documentation is available in the C API: DDS_Locator_t

Member Function Documentation

Equals() [1/2]

bool Equals

(

Locator

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

With()

Locator With

(

Action< LocatorBuilder >

build

)

Creates a new Locator with a set of changes specified in an Action

Parameters

build

An Action (typically a lambda function) that receives a modifiable object with the current values of this Locator.

Returns

A new Locator with the changes applied by the Action

Member Data Documentation

InvalidKind

const int InvalidKind

static

Locator of this kind is invalid.

The full documentation is available in the C API: DDS_LOCATOR_KIND_INVALID

InvalidPort

const uint InvalidPort

static

An invalid port.

The full documentation is available in the C API: DDS_LOCATOR_PORT_INVALID

ReservedKind

const int ReservedKind

static

Locator of this kind is reserved.

The full documentation is available in the C API: DDS_LOCATOR_KIND_RESERVED

Shmem510Kind

const int Shmem510Kind

static

A locator for an address accessed via shared memory for RTI Connext 5.1.0 and earlier.

The full documentation is available in the C API: DDS_LOCATOR_KIND_SHMEM_510

ShmemKind

const int ShmemKind

static

A locator for an address accessed via shared memory.

The full documentation is available in the C API: DDS_LOCATOR_KIND_SHMEM

UdPv4Kind

const int UdPv4Kind

static

A locator for a UDPv4 address.

The full documentation is available in the C API: DDS_LOCATOR_KIND_UDPv4

UdPv4WanKind

const int UdPv4WanKind

static

A locator for a UDPv4 WAN address.

The full documentation is available in the C API: DDS_LOCATOR_KIND_UDPv4_WAN

UdPv6510Kind

const int UdPv6510Kind

static

A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier.

The full documentation is available in the C API: DDS_LOCATOR_KIND_UDPv6_510

UdPv6Kind

const int UdPv6Kind

static

A locator for a UDPv6 address.

The full documentation is available in the C API: DDS_LOCATOR_KIND_UDPv6

Property Documentation

Address

ImmutableList<byte> Address

get

The IP address.

The full documentation is available in the C API: DDS_Locator_t::address

Default

Locator Default

staticget

Singleton containing the default value of a Locator

InvalidAddress

ImmutableList<byte> InvalidAddress

staticget

An invalid address.

The full documentation is available in the C API: DDS_LOCATOR_ADDRESS_INVALID

Kind

int Kind

get

The kind of locator.

The full documentation is available in the C API: DDS_Locator_t::kind

LocatorInvalid

Locator LocatorInvalid

staticget

An invalid locator.

The full documentation is available in the C API: DDS_LOCATOR_INVALID

Port

uint Port

get

The port number.

The full documentation is available in the C API: DDS_Locator_t::port