Rti.Dds.Core.Policy.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 = new UserData(ImmutableList<byte>.Empty) [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]

Rti.Dds.Core.Policy.UserData.UserData ( IEnumerable< byte >  value )

inline

Creates a UserData object with a list of bytes

UserData() [2/2]

Rti.Dds.Core.Policy.UserData.UserData

(

ImmutableList< byte >

value

)

Creates a UserData object with a list of bytes

Member Function Documentation

With()

UserData Rti.Dds.Core.Policy.UserData.With ( Action< ImmutableList< byte >.Builder >  build )

inline

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

Parameters

build

An 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

GetHashCode()

override int Rti.Dds.Core.Policy.UserData.GetHashCode

(

)

Gets the hash code

Equals() [1/2]

override bool Rti.Dds.Core.Policy.UserData.Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Rti.Dds.Core.Policy.UserData.Equals ( UserData  other )

inline

Compares for equality

Property Documentation

Value

ImmutableList<byte> Rti.Dds.Core.Policy.UserData.Value

get

An opaque sequence of bytes.

The full documentation is available in the C API: DDS_UserDataQosPolicy_value

Default

UserData Rti.Dds.Core.Policy.UserData.Default = new UserData(ImmutableList<byte>.Empty)

staticget

Singleton containing the default value of a UserData