RTI Connext C# API  6.1.2
UserData Class Reference

Provides an area where your application can store additional information related to a Domain.DomainParticipant, Publication.DataWriter<T> or Subscription.DataReader<T> More...

Inherits IEquatable< UserData >.

Public Member Functions

 UserData (IEnumerable< byte > value)
 Creates a UserData object with a list of bytes More...
 
 UserData (ImmutableList< byte > value)
 Creates a UserData object with a list of bytes More...
 
UserData With (Action< ImmutableList< byte >.Builder > build)
 Creates a new UserData 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 (UserData other)
 Compares for equality More...
 

Properties

ImmutableList< byte > Value [get]
 An opaque sequence of bytes. More...
 
static UserData Default [get]
 Singleton containing the default value of a UserData More...
 

Detailed Description

Provides an area where your application can store additional information related to a Domain.DomainParticipant, Publication.DataWriter<T> or Subscription.DataReader<T>

The full documentation is available in the C API: DDS_UserDataQosPolicy

Constructor & Destructor Documentation

◆ UserData() [1/2]

UserData ( IEnumerable< byte >  value)

Creates a UserData object with a list of bytes

◆ UserData() [2/2]

UserData ( ImmutableList< byte >  value)

Creates a UserData object with a list of bytes

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Equals ( UserData  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

UserData With ( Action< ImmutableList< byte >.Builder >  build)

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

Parameters
buildAn Action (typically a lambda function) that receives a modifiable list with the current values of this object's Value.
Returns
A new UserData with the changes applied by the Action

Property Documentation

◆ Default

UserData Default
staticget

Singleton containing the default value of a UserData

◆ Value

ImmutableList<byte> Value
get

An opaque sequence of bytes.

The full documentation is available in the C API: DDS_UserDataQosPolicy::value