OpenSplice C# API  v6.x
OpenSplice C# Data Distribution Service Data-Centric Publish-Subscribe API
DDS.TopicQos Struct Reference

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

Collaboration diagram for DDS.TopicQos:
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 DataReader timely orders the data. More...
 
DurabilityQosPolicy Durability
 Specifies whether the data should be stored for late joining readers. More...
 
DurabilityServiceQosPolicy DurabilityService
 Specifies the behaviour of the “transient/persistent service” of the Data Distribution System regarding Transient and Persistent Topic instances. More...
 
HistoryQosPolicy History
 Specifies how samples should be stored. More...
 
LatencyBudgetQosPolicy LatencyBudget
 Used by the Data Distribution Service for optimization. More...
 
LifespanQosPolicy Lifespan
 Specifies the maximum duration of validity of the data written by a DataWriter. More...
 
LivelinessQosPolicy Liveliness
 Specifies the way the liveliness of the Topic is asserted to the Data Distribution Service. More...
 
OwnershipQosPolicy Ownership
 Specifies whether a DataWriter exclusively owns an instance. More...
 
ReliabilityQosPolicy Reliability
 Specifies the reliability of the data distribution. More...
 
ResourceLimitsQosPolicy ResourceLimits
 Specifies the maximum amount of resources to be used. More...
 
TopicDataQosPolicy TopicData
 Used to attach additional information to the Topic. More...
 
TransportPriorityQosPolicy TransportPriority
 Specifies a priority hint for the underlying transport layer. More...
 

Detailed Description

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

A QosPolicy can be set when the ITopic is created with the IDomainParticipant.CreateTopic operation (or modified with the SetQos operation). Both operations take the TopicQos 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 ITopic creation time or prior to calling the Enable operation on the ITopic.

The initial value of the default TopicQos in the IDomainParticipant are given in the following table:

QosPolicyAttributeDefault Value
TopicQos.TopicDataTopicDataQosPolicy.Valueempty
TopicQos.DurabilityDurabilityQosPolicy.KindVolatile
TopicQos.DurabilityServiceDurabilityServiceQosPolicy.HistoryKindKeepLastHistoryQos
DurabilityServiceQosPolicy.HistoryDepth1
DurabilityServiceQosPolicy.MaxInstancesLength.Unlimited
DurabilityServiceQosPolicy.MaxSamplesLength.Unlimited
DurabilityServiceQosPolicy.MaxSamplesPerInstanceLength.Unlimited
DurabilityServiceQosPolicy.ServiceCleanupDelayDuration.Zero
TopicQos.DeadlineDeadlineQosPolicy.PeriodDuration.Infinite
TopicQos.LatencyBudgetLatencyBudgetQosPolicy.DurationDuration.Zero
TopicQos.LivelinessLivelinessQosPolicy.KindAutomaticLivelinessQos
LivelinessQosPolicy.LeaseDurationDuration.Infinite
TopicQos.ReliabilityReliabilityQosPolicy.KindBestEffortReliabilityQos
ReliabilityQosPolicy.MaxBlockingTime100 ms
ReliabilityQosPolicy.synchronousfalse
TopicQos.DestinationOrderDestinationOrderQosPolicy.KindByReceptionTimestampDestinationOrderQos
TopicQos.HistoryHistoryQosPolicy.KindKeepLastHistoryQos
HistoryQosPolicy.Depth1
TopicQos.ResourceLimitsResourceLimitsQosPolicy.MaxInstancesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesPerInstanceLength.Unlimited
TopicQos.TransportPriorityTransportPriorityQosPolicy.Value0
TopicQos.LifespanLifespanQosPolicy.DurationDuration.Infinite
TopicQos.OwnershipOwnershipQosPolicy.KindSharedOwnershipQos
See also
Supported Quality of Service (QoS)

Definition at line 1886 of file DdsDcpsStructs.cs.

Member Data Documentation

◆ Deadline

DeadlineQosPolicy DDS.TopicQos.Deadline

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

For detailed information see Deadline QoS

Definition at line 1916 of file DdsDcpsStructs.cs.

◆ DestinationOrder

DestinationOrderQosPolicy DDS.TopicQos.DestinationOrder

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

For detailed information see DestinationOrder QoS

Definition at line 1944 of file DdsDcpsStructs.cs.

◆ Durability

DurabilityQosPolicy DDS.TopicQos.Durability

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

For detailed information see Durability QoS

Definition at line 1901 of file DdsDcpsStructs.cs.

◆ DurabilityService

DurabilityServiceQosPolicy DDS.TopicQos.DurabilityService

Specifies the behaviour of the “transient/persistent service” of the Data Distribution System regarding Transient and Persistent Topic instances.

For detailed information see DurabilityService QoS

Definition at line 1909 of file DdsDcpsStructs.cs.

◆ History

HistoryQosPolicy DDS.TopicQos.History

Specifies how samples should be stored.

For detailed information see History QoS

Definition at line 1951 of file DdsDcpsStructs.cs.

◆ LatencyBudget

LatencyBudgetQosPolicy DDS.TopicQos.LatencyBudget

Used by the Data Distribution Service for optimization.

For detailed information see LatencyBudget QoS

Definition at line 1923 of file DdsDcpsStructs.cs.

◆ Lifespan

LifespanQosPolicy DDS.TopicQos.Lifespan

Specifies the maximum duration of validity of the data written by a DataWriter.

For detailed information see Lifespan QoS

Definition at line 1972 of file DdsDcpsStructs.cs.

◆ Liveliness

LivelinessQosPolicy DDS.TopicQos.Liveliness

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

For detailed information see Liveliness QoS

Definition at line 1930 of file DdsDcpsStructs.cs.

◆ Ownership

OwnershipQosPolicy DDS.TopicQos.Ownership

Specifies whether a DataWriter exclusively owns an instance.

For detailed information see Ownership QoS

Definition at line 1979 of file DdsDcpsStructs.cs.

◆ Reliability

ReliabilityQosPolicy DDS.TopicQos.Reliability

Specifies the reliability of the data distribution.

For detailed information see Reliability QoS

Definition at line 1937 of file DdsDcpsStructs.cs.

◆ ResourceLimits

ResourceLimitsQosPolicy DDS.TopicQos.ResourceLimits

Specifies the maximum amount of resources to be used.

For detailed information see ResourceLimits QoS

Definition at line 1958 of file DdsDcpsStructs.cs.

◆ TopicData

TopicDataQosPolicy DDS.TopicQos.TopicData

Used to attach additional information to the Topic.

For detailed information see Topic Data QoS

Definition at line 1894 of file DdsDcpsStructs.cs.

◆ TransportPriority

TransportPriorityQosPolicy DDS.TopicQos.TransportPriority

Specifies a priority hint for the underlying transport layer.

For detailed information see TransportPriority QoS

Definition at line 1965 of file DdsDcpsStructs.cs.


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