Rti.Types.Builtin.KeyedOctetsTopicType Class Reference

A keyed topic-type containing a string (the key) and a sequence of bytes. This type can be used to instantiate a Rti.Dds.Topics.Topic<T>. More...

Inherits IEquatable< KeyedOctetsTopicType >.

Public Member Functions
	KeyedOctetsTopicType ()
	Creates an instance with an empty key and an empty sequence. More...
	KeyedOctetsTopicType (string Key, ISequence< byte > Value)
	Creates an instance with the given key and sequence of bytes. More...
	KeyedOctetsTopicType (KeyedOctetsTopicType other)
	Creates an instance with a copy of another instance (the sequence elements are also copied). More...
override int	GetHashCode ()
	Gets a simple hashcode based on the key and the number of elements. More...
bool	Equals (KeyedOctetsTopicType other)
	Compares the key and the full sequence More...
override bool	Equals (object obj)
	Compares the key and the full sequence More...
override string	ToString ()
	Converts to string More...

Properties
string	Key = string.Empty [get, set]
	The key (its maximum size is 1024 bytes in UTF-8 format) More...
ISequence< byte >	Value [get]
	The sequence of octets (its maximum size is 2048) More...

Detailed Description

A keyed topic-type containing a string (the key) and a sequence of bytes. This type can be used to instantiate a Rti.Dds.Topics.Topic<T>.

This type is equivalent to the following IDL type:

struct KeyedOctetsTopicType {
    @key string<1024> key;
    sequence<octet, 2048> value;
};

Constructor & Destructor Documentation

KeyedOctetsTopicType() [1/3]

Rti.Types.Builtin.KeyedOctetsTopicType.KeyedOctetsTopicType ( )

inline

Creates an instance with an empty key and an empty sequence.

KeyedOctetsTopicType() [2/3]

Rti.Types.Builtin.KeyedOctetsTopicType.KeyedOctetsTopicType ( string  Key, ISequence< byte >  Value  )

inline

Creates an instance with the given key and sequence of bytes.

KeyedOctetsTopicType() [3/3]

Rti.Types.Builtin.KeyedOctetsTopicType.KeyedOctetsTopicType ( KeyedOctetsTopicType  other )

inline

Creates an instance with a copy of another instance (the sequence elements are also copied).

Member Function Documentation

GetHashCode()

override int Rti.Types.Builtin.KeyedOctetsTopicType.GetHashCode ( )

inline

Gets a simple hashcode based on the key and the number of elements.

Equals() [1/2]

bool Rti.Types.Builtin.KeyedOctetsTopicType.Equals ( KeyedOctetsTopicType  other )

inline

Compares the key and the full sequence

Equals() [2/2]

override bool Rti.Types.Builtin.KeyedOctetsTopicType.Equals

(

object

obj

)

Compares the key and the full sequence

ToString()

override string Rti.Types.Builtin.KeyedOctetsTopicType.ToString

(

)

Converts to string

Property Documentation

Key

string Rti.Types.Builtin.KeyedOctetsTopicType.Key = string.Empty

getset

The key (its maximum size is 1024 bytes in UTF-8 format)

Value

ISequence<byte> Rti.Types.Builtin.KeyedOctetsTopicType.Value

get

The sequence of octets (its maximum size is 2048)