OpenSplice C# API  v6.x
OpenSplice C# Data Distribution Service Data-Centric Publish-Subscribe API
Public Attributes | List of all members
DDS.DataReaderQos Struct Reference

This struct provides the basic mechanism for an application to specify Quality of Service attributes for an IDataReader. More...

Collaboration diagram for DDS.DataReaderQos:
Collaboration graph

Public Attributes

DeadlineQosPolicy Deadline
 Specifies the period within which a new sample is expected or written. More...
 
DestinationOrderQosPolicy DestinationOrder
 Specifies the order in which the IDataReader timely orders the data. More...
 
DurabilityQosPolicy Durability
 Specifies whether the data should be stored for late joining readers. More...
 
HistoryQosPolicy History
 
LatencyBudgetQosPolicy LatencyBudget
 Used by the Data Distribution Service for optimization. More...
 
LivelinessQosPolicy Liveliness
 Specifies the way the liveliness of the IDataReader is asserted to the Data Distribution Service. More...
 
OwnershipQosPolicy Ownership
 Specifies whether a IDataWriter exclusively owns an instance. More...
 
ReaderDataLifecycleQosPolicy ReaderDataLifecycle
 Specifies the lifecycle of the data instances and samples. More...
 
ReaderLifespanQosPolicy ReaderLifespan
 Specifies the maximum duration of validity of the data in the IDataReader. More...
 
ReliabilityQosPolicy Reliability
 Specifies the reliability of the data distribution. More...
 
ResourceLimitsQosPolicy ResourceLimits
 Specifies the maximum amount of resources to be used. More...
 
ShareQosPolicy Share
 Specifies if this IDataReader is shared DataReader More...
 
SubscriptionKeyQosPolicy SubscriptionKeys
 Specifies that the IDataReader should order the data with an alternative key More...
 
TimeBasedFilterQosPolicy TimeBasedFilter
 Specifies the maximum data rate at which the IDataReader will receive changes. More...
 
UserDataQosPolicy UserData
 Used to attach additional information to the IDataReadder. More...
 

Detailed Description

This struct provides the basic mechanism for an application to specify Quality of Service attributes for an IDataReader.

A QosPolicy can be set when the IDataReader is created with the ISubscriber.CreateDataReader operation (or modified with the SetQos operation). Both operations take the DataReaderQos object as a parameter. There may be cases where several policies are in conflict. Consistency checking is performed each time the policies are modified when they are being created and, in case they are already enabled, via the SetQos operation.

Some QosPolicy have “immutable” semantics meaning that they can only be specified either at IDataReader creation time or prior to calling the Enable operation on the IDataReader.

The initial value of the default DataReaderQos in the ISubscriber are given in the following table:

QosPolicyAttributeDefault Value
DataReaderQos.UserDataUserDataQosPolicy.Valueempty
DataReaderQos.DurabilityDurabilityQosPolicy.KindVolatile
DataReaderQos.DeadlineDeadlineQosPolicy.PeriodDuration.Infinite
DataReaderQos.LatencyBudgetLatencyBudgetQosPolicy.DurationDuration.Zero
DataReaderQos.LivelinessLivelinessQosPolicy.KindAutomaticLivelinessQos
LivelinessQosPolicy.LeaseDurationDuration.Infinite
DataReaderQos.ReliabilityReliabilityQosPolicy.KindBestEffortReliabilityQos
ReliabilityQosPolicy.MaxBlockingTime100 ms
ReliabilityQosPolicy.synchronousfalse
DataReaderQos.DestinationOrderDestinationOrderQosPolicy.KindByReceptionTimestampDestinationOrderQos
DataWriterQos.HistoryHistoryQosPolicy.KindKeepLastHistoryQos
HistoryQosPolicy.Depth1
DataReaderQos.ResourceLimitsResourceLimitsQosPolicy.MaxInstancesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesPerInstanceLength.Unlimited
DataReaderQos.ReaderLifespanReaderLifespanQosPolicy.DurationDuration.Infinite
DataReaderQos.OwnershipOwnershipQosPolicy.KindSharedOwnershipQos
DataReaderQos.TimeBasedFilterTimeBasedFilterQosPolicy.MinimumSeparation0
DataReaderQos.ReaderDataLifecycleReaderDataLifecycleQosPolicy.AutoPurgeDisposedSamplesDelayDuration.Infinite
ReaderDataLifecycleQosPolicy.AutoPurgeNoWriterSamplesDelayDuration.Infinite
ReaderDataLifecycleQosPolicy.EnableInvalidSamplestrue
ReaderDataLifecycleQosPolicy.InvalidSampleVisibility.KindMinimumInvalidSamples
ReaderDataLifecycleQosPolicy.AutopurgeDisposeAllfalse
DataReaderQos.SubscriptionKeysSubscriptionKeyQosPolicy.KeyListempty
SubscriptionKeyQosPolicy.UseKeyListfalse
DataReaderQos.ReaderLifespanReaderLifespanQosPolicy.DurationDuration.Infinite
ReaderLifespanQosPolicy.UseLifespanfalse
DataReaderQos.ShareShareQosPolicy.Enablefalse
ShareQosPolicy.Namenull
See also
Supported Quality of Service (QoS)

Definition at line 2261 of file DdsDcpsStructs.cs.

Member Data Documentation

◆ Deadline

DeadlineQosPolicy DDS.DataReaderQos.Deadline

Specifies the period within which a new sample is expected or written.

For detailed information see Deadline QoS

Definition at line 2276 of file DdsDcpsStructs.cs.

◆ DestinationOrder

DestinationOrderQosPolicy DDS.DataReaderQos.DestinationOrder

Specifies the order in which the IDataReader timely orders the data.

For detailed information see DestinationOrder QoS

Definition at line 2304 of file DdsDcpsStructs.cs.

◆ Durability

DurabilityQosPolicy DDS.DataReaderQos.Durability

Specifies whether the data should be stored for late joining readers.

For detailed information see Durability QoS

Definition at line 2269 of file DdsDcpsStructs.cs.

◆ History

HistoryQosPolicy DDS.DataReaderQos.History

Specifies how samples should be stored.

For detailed information see History QoS

Definition at line 2311 of file DdsDcpsStructs.cs.

◆ LatencyBudget

LatencyBudgetQosPolicy DDS.DataReaderQos.LatencyBudget

Used by the Data Distribution Service for optimization.

For detailed information see LatencyBudget QoS

Definition at line 2283 of file DdsDcpsStructs.cs.

◆ Liveliness

LivelinessQosPolicy DDS.DataReaderQos.Liveliness

Specifies the way the liveliness of the IDataReader is asserted to the Data Distribution Service.

For detailed information see Liveliness QoS

Definition at line 2290 of file DdsDcpsStructs.cs.

◆ Ownership

OwnershipQosPolicy DDS.DataReaderQos.Ownership

Specifies whether a IDataWriter exclusively owns an instance.

For detailed information see Ownership QoS

Definition at line 2332 of file DdsDcpsStructs.cs.

◆ ReaderDataLifecycle

ReaderDataLifecycleQosPolicy DDS.DataReaderQos.ReaderDataLifecycle

Specifies the lifecycle of the data instances and samples.

This QosPolicy determines whether instance state changes (either NOT_ALIVE_NO_WRITERS_INSTANCE_STATE or NOT_ALIVE_DISPOSED_INSTANCE_STATE) are presented to the user when no corresponding samples are available to communicate them. Also it determines how long an instance state change remains available to a user that does not explicitly consume them.

For detailed information see Reader Data Lifecycle QoS

Definition at line 2352 of file DdsDcpsStructs.cs.

◆ ReaderLifespan

ReaderLifespanQosPolicy DDS.DataReaderQos.ReaderLifespan

Specifies the maximum duration of validity of the data in the IDataReader.

Note
Proprietary Policy

Definition at line 2371 of file DdsDcpsStructs.cs.

◆ Reliability

ReliabilityQosPolicy DDS.DataReaderQos.Reliability

Specifies the reliability of the data distribution.

For detailed information see Reliability QoS

Definition at line 2297 of file DdsDcpsStructs.cs.

◆ ResourceLimits

ResourceLimitsQosPolicy DDS.DataReaderQos.ResourceLimits

Specifies the maximum amount of resources to be used.

For detailed information see ResourceLimits QoS

Definition at line 2318 of file DdsDcpsStructs.cs.

◆ Share

ShareQosPolicy DDS.DataReaderQos.Share

Specifies if this IDataReader is shared DataReader

Note
Proprietary Policy

The Snare QoSPolicy is used to have several API IDataReader entities to refer to the same underlying DataReader instance. When enables the Name attribute is used to combine the DataReaders which have the same Name.

Definition at line 2382 of file DdsDcpsStructs.cs.

◆ SubscriptionKeys

SubscriptionKeyQosPolicy DDS.DataReaderQos.SubscriptionKeys

Specifies that the IDataReader should order the data with an alternative key

Note
Proprietary Policy

The SubscriptionKeys QosPolicy allows to specify an alternative key to be used by the IDataReader to order the received data instances. When enabled the provided subscription keys are used instead of the keys associated with the ITopic.

Definition at line 2364 of file DdsDcpsStructs.cs.

◆ TimeBasedFilter

TimeBasedFilterQosPolicy DDS.DataReaderQos.TimeBasedFilter

Specifies the maximum data rate at which the IDataReader will receive changes.

For detailed information see Time Based Filter QoS

Definition at line 2339 of file DdsDcpsStructs.cs.

◆ UserData

UserDataQosPolicy DDS.DataReaderQos.UserData

Used to attach additional information to the IDataReadder.

For detailed information see User Data QoS

Definition at line 2325 of file DdsDcpsStructs.cs.

The documentation for this struct was generated from the following file: