RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Cookie Class Reference

Unique identifier for a written data sample in the form of a sequence of bytes. More...

Inherits IEquatable< Cookie >.

Public Member Functions

 Cookie (IEnumerable< byte > value)
 Creates a new Cookie instance with the bytes inside a container. More...
 
 Cookie (ImmutableList< byte > value)
 Creates a Cookie with from a list of bytes. More...
 
Cookie With (Action< ImmutableList< byte >.Builder > build)
 Creates a new Cokie 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 (Cookie other)
 Compares for equality. More...
 

Properties

ImmutableList< byte > Value [get]
 A sequence of bytes. More...
 
static Cookie Empty = new Cookie(ImmutableList<byte>.Empty) [get]
 Creates a new empty Cookie instance. More...
 

Detailed Description

Unique identifier for a written data sample in the form of a sequence of bytes.

The full documentation is available in the C API: DDS_Cookie_t

Constructor & Destructor Documentation

◆ Cookie() [1/2]

Rti.Dds.Core.Cookie.Cookie ( IEnumerable< byte >  value)
inline

Creates a new Cookie instance with the bytes inside a container.

◆ Cookie() [2/2]

Rti.Dds.Core.Cookie.Cookie ( ImmutableList< byte >  value)

Creates a Cookie with from a list of bytes.

Member Function Documentation

◆ With()

Cookie Rti.Dds.Core.Cookie.With ( Action< ImmutableList< byte >.Builder >  build)
inline

Creates a new Cokie 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 Cookie with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Cookie.GetHashCode ( )
inline

Gets the hash code.

◆ Equals() [1/2]

override bool Rti.Dds.Core.Cookie.Equals ( object  other)

Compares for equality.

◆ Equals() [2/2]

bool Rti.Dds.Core.Cookie.Equals ( Cookie  other)
inline

Compares for equality.

Property Documentation

◆ Value

ImmutableList<byte> Rti.Dds.Core.Cookie.Value
get

A sequence of bytes.

The full documentation is available in the C API: DDS_Cookie_t_value

◆ Empty

Cookie Rti.Dds.Core.Cookie.Empty = new Cookie(ImmutableList<byte>.Empty)
staticget

Creates a new empty Cookie instance.