RTI Connext C# API Version 7.3.0
Rti.Dds.Core.Policy.Availability Class Reference

configures the availability of data. More...

Inherits IEquatable< Availability >.

Public Member Functions

Availability With (Action< AvailabilityBuilder > build)
 Creates a new Availability 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 (Availability other)
 Compares for equality More...
 

Properties

bool EnableRequiredSubscriptions [get]
 Enables support for required subscriptions in a Publication.DataWriter<T> More...
 
Duration MaxDataAvailabilityWaitingTime [get]
 Defines how much time to wait before delivering a sample to the application without having received some of the previous samples. More...
 
Duration MaxEndpointAvailabilityWaitingTime [get]
 Defines how much time to wait to discover DataWriters providing samples for the same data source (virtual GUID). More...
 
ImmutableList< EndpointGroupRequiredMatchedEndpointGroups [get]
 A sequence of endpoint groups. More...
 
static Availability Default [get]
 Singleton containing the default value of a Availability More...
 

Detailed Description

configures the availability of data.

The full documentation is available in the C API: DDS_AvailabilityQosPolicy

Member Function Documentation

◆ With()

Availability Rti.Dds.Core.Policy.Availability.With ( Action< AvailabilityBuilder build)
inline

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

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

◆ GetHashCode()

override int Rti.Dds.Core.Policy.Availability.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.Availability.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.Availability.Equals ( Availability  other)
inline

Compares for equality

Property Documentation

◆ EnableRequiredSubscriptions

bool Rti.Dds.Core.Policy.Availability.EnableRequiredSubscriptions
get

Enables support for required subscriptions in a Publication.DataWriter<T>

The full documentation is available in the C API: DDS_AvailabilityQosPolicy_enable_required_subscriptions

◆ MaxDataAvailabilityWaitingTime

Duration Rti.Dds.Core.Policy.Availability.MaxDataAvailabilityWaitingTime
get

Defines how much time to wait before delivering a sample to the application without having received some of the previous samples.

The full documentation is available in the C API: DDS_AvailabilityQosPolicy_max_data_availability_waiting_time

◆ MaxEndpointAvailabilityWaitingTime

Duration Rti.Dds.Core.Policy.Availability.MaxEndpointAvailabilityWaitingTime
get

Defines how much time to wait to discover DataWriters providing samples for the same data source (virtual GUID).

The full documentation is available in the C API: DDS_AvailabilityQosPolicy_max_endpoint_availability_waiting_time

◆ RequiredMatchedEndpointGroups

ImmutableList<EndpointGroup> Rti.Dds.Core.Policy.Availability.RequiredMatchedEndpointGroups
get

A sequence of endpoint groups.

The full documentation is available in the C API: DDS_AvailabilityQosPolicy_required_matched_endpoint_groups

◆ Default

Availability Rti.Dds.Core.Policy.Availability.Default
staticget

Singleton containing the default value of a Availability