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

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

Collaboration diagram for DDS.DataWriterQos:
Collaboration graph

Public Attributes

DeadlineQosPolicy Deadline
 Specifies the behaviour of the “transient/persistent service” of the Data Distribution System regarding Transient and Persistent Topic instances. 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
 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 IDataWriter. More...
 
LivelinessQosPolicy Liveliness
 Specifies the way the liveliness of the IDataWriter is asserted to the Data Distribution Service. More...
 
OwnershipQosPolicy Ownership
 Specifies whether a IDataWriter exclusively owns an instance. More...
 
OwnershipStrengthQosPolicy OwnershipStrength
 Specifies the strength to determine the ownership. More...
 
ReliabilityQosPolicy Reliability
 Specifies the reliability of the data distribution. More...
 
ResourceLimitsQosPolicy ResourceLimits
 Specifies the maximum amount of resources to be used. More...
 
TransportPriorityQosPolicy TransportPriority
 Specifies a priority hint for the underlying transport layer. More...
 
UserDataQosPolicy UserData
 Used to attach additional information to the IDataWriter. More...
 
WriterDataLifecycleQosPolicy WriterDataLifecycle
 Specifies whether unregistered instances are disposed of automatically or not. More...
 

Detailed Description

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

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

The initial value of the default DataWriterQos in the IPublisher are given in the following table:

QosPolicyAttributeDefault Value
DataWriterQos.UserDataUserDataQosPolicy.Valueempty
DataWriterQos.DurabilityDurabilityQosPolicy.KindVolatile
DataWriterQos.DeadlineDeadlineQosPolicy.PeriodDuration.Infinite
DataWriterQos.LatencyBudgetLatencyBudgetQosPolicy.DurationDuration.Zero
DataWriterQos.LivelinessLivelinessQosPolicy.KindAutomaticLivelinessQos
LivelinessQosPolicy.LeaseDurationDuration.Infinite
DataWriterQos.ReliabilityReliabilityQosPolicy.KindBestEffortReliabilityQos
ReliabilityQosPolicy.MaxBlockingTime100 ms
ReliabilityQosPolicy.synchronousfalse
DataWriterQos.DestinationOrderDestinationOrderQosPolicy.KindByReceptionTimestampDestinationOrderQos
DataWriterQos.HistoryHistoryQosPolicy.KindKeepLastHistoryQos
HistoryQosPolicy.Depth1
DataWriterQos.ResourceLimitsResourceLimitsQosPolicy.MaxInstancesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesLength.Unlimited
ResourceLimitsQosPolicy.MaxSamplesPerInstanceLength.Unlimited
DataWriterQos.TransportPriorityTransportPriorityQosPolicy.Value0
DataWriterQos.LifespanLifespanQosPolicy.DurationDuration.Infinite
DataWriterQos.OwnershipOwnershipQosPolicy.KindSharedOwnershipQos
DataWriterQos.OwnershipStrengthOwnershipStrengthQosPolicy.Value0
DataWriterQos.WriterDataLifecycleWriterDataLifecycleQosPolicy.AutoDisposeUnregisteredInstancestrue
WriterDataLifecycleQosPolicy.AutopurgeSuspendedSamplesDelayDuration.Infinite
WriterDataLifecycleQosPolicy.AutounregisterInstanceDelayDuration.Infinite
See also
Supported Quality of Service (QoS)

Definition at line 2061 of file DdsDcpsStructs.cs.

Member Data Documentation

◆ Deadline

DeadlineQosPolicy DDS.DataWriterQos.Deadline

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 2077 of file DdsDcpsStructs.cs.

◆ DestinationOrder

DestinationOrderQosPolicy DDS.DataWriterQos.DestinationOrder

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

For detailed information see DestinationOrder QoS

Definition at line 2105 of file DdsDcpsStructs.cs.

◆ Durability

DurabilityQosPolicy DDS.DataWriterQos.Durability

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

For detailed information see Durability QoS

Definition at line 2069 of file DdsDcpsStructs.cs.

◆ History

HistoryQosPolicy DDS.DataWriterQos.History

Specifies how samples should be stored.

For detailed information see History QoS

Definition at line 2112 of file DdsDcpsStructs.cs.

◆ LatencyBudget

LatencyBudgetQosPolicy DDS.DataWriterQos.LatencyBudget

Used by the Data Distribution Service for optimization.

For detailed information see LatencyBudget QoS

Definition at line 2084 of file DdsDcpsStructs.cs.

◆ Lifespan

LifespanQosPolicy DDS.DataWriterQos.Lifespan

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

For detailed information see Lifespan QoS

Definition at line 2133 of file DdsDcpsStructs.cs.

◆ Liveliness

LivelinessQosPolicy DDS.DataWriterQos.Liveliness

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

For detailed information see Liveliness QoS

Definition at line 2091 of file DdsDcpsStructs.cs.

◆ Ownership

OwnershipQosPolicy DDS.DataWriterQos.Ownership

Specifies whether a IDataWriter exclusively owns an instance.

For detailed information see Ownership QoS

Definition at line 2146 of file DdsDcpsStructs.cs.

◆ OwnershipStrength

OwnershipStrengthQosPolicy DDS.DataWriterQos.OwnershipStrength

Specifies the strength to determine the ownership.

For detailed information see Ownership Strength QoS

Definition at line 2153 of file DdsDcpsStructs.cs.

◆ Reliability

ReliabilityQosPolicy DDS.DataWriterQos.Reliability

Specifies the reliability of the data distribution.

For detailed information see Reliability QoS

Definition at line 2098 of file DdsDcpsStructs.cs.

◆ ResourceLimits

ResourceLimitsQosPolicy DDS.DataWriterQos.ResourceLimits

Specifies the maximum amount of resources to be used.

For detailed information see ResourceLimits QoS

Definition at line 2119 of file DdsDcpsStructs.cs.

◆ TransportPriority

TransportPriorityQosPolicy DDS.DataWriterQos.TransportPriority

Specifies a priority hint for the underlying transport layer.

For detailed information see TransportPriority QoS

Definition at line 2126 of file DdsDcpsStructs.cs.

◆ UserData

UserDataQosPolicy DDS.DataWriterQos.UserData

Used to attach additional information to the IDataWriter.

For detailed information see Topic Data QoS

Definition at line 2139 of file DdsDcpsStructs.cs.

◆ WriterDataLifecycle

WriterDataLifecycleQosPolicy DDS.DataWriterQos.WriterDataLifecycle

Specifies whether unregistered instances are disposed of automatically or not.

For detailed information see Writer Data Lifecycle QoS

Definition at line 2160 of file DdsDcpsStructs.cs.

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