RTI Connext C# API Version 7.2.0
Rti.Dds.Core.InstanceHandle Struct Reference

Handle to identity different instances of the same Topics.Topic<T> of a certain type. More...

Inherits IEquatable< InstanceHandle >, and IComparable< InstanceHandle >.

Public Member Functions

bool IsNil ()
 Compare this handle to Nil More...
 
bool Equals (InstanceHandle other)
 Compares this instance handle with another handle for equality. More...
 
int CompareTo (InstanceHandle other)
 Compares this instance handle with another handle. More...
 
override bool Equals (object obj)
 Compares this instance handle with another handle for equality. More...
 
override int GetHashCode ()
 Generates a hash code from this InstanceHandle. More...
 
override string ToString ()
 Returns a string representation of this InstanceHandle More...
 
byte[] ToArray ()
 Converts this instance handle to a byte array. More...
 

Static Public Member Functions

static InstanceHandle FromArray (byte[] bytes)
 Creates a non-Nil InstanceHandle from the bytes in a 16-byte array More...
 

Properties

static InstanceHandle Nil = new InstanceHandle(DDS_InstanceHandle_t.Nil) [get]
 The NIL instance handle. More...
 

Detailed Description

Handle to identity different instances of the same Topics.Topic<T> of a certain type.

The full documentation is available in the C API: DDS_InstanceHandle_t

Member Function Documentation

◆ IsNil()

bool Rti.Dds.Core.InstanceHandle.IsNil ( )

Compare this handle to Nil

The full documentation is available in the C API: DDS_InstanceHandle_t_is_nil

◆ Equals() [1/2]

bool Rti.Dds.Core.InstanceHandle.Equals ( InstanceHandle  other)

Compares this instance handle with another handle for equality.

The full documentation is available in the C API: DDSInstanceHandleEquals

◆ CompareTo()

int Rti.Dds.Core.InstanceHandle.CompareTo ( InstanceHandle  other)

Compares this instance handle with another handle.

The full documentation is available in the C API: DDSInstanceHandleCompare

◆ Equals() [2/2]

override bool Rti.Dds.Core.InstanceHandle.Equals ( object  obj)

Compares this instance handle with another handle for equality.

The full documentation is available in the C API: DDSInstanceHandleEquals

◆ GetHashCode()

override int Rti.Dds.Core.InstanceHandle.GetHashCode ( )

Generates a hash code from this InstanceHandle.

◆ ToString()

override string Rti.Dds.Core.InstanceHandle.ToString ( )

Returns a string representation of this InstanceHandle

◆ ToArray()

byte[] Rti.Dds.Core.InstanceHandle.ToArray ( )

Converts this instance handle to a byte array.

◆ FromArray()

static InstanceHandle Rti.Dds.Core.InstanceHandle.FromArray ( byte[]  bytes)
inlinestatic

Creates a non-Nil InstanceHandle from the bytes in a 16-byte array

Property Documentation

◆ Nil

InstanceHandle Rti.Dds.Core.InstanceHandle.Nil = new InstanceHandle(DDS_InstanceHandle_t.Nil)
staticget

The NIL instance handle.

The full documentation is available in the C API: DDSInstanceHandle_tHANDLE_NIL