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

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

Collaboration diagram for DDS.SubscriberQos:
Collaboration graph

Public Attributes

EntityFactoryQosPolicy EntityFactory
 Specifies whether a just created IDataReader should be enabled More...
 
GroupDataQosPolicy GroupData
 Used to attach additional information to the ISubscriber. More...
 
PartitionQosPolicy Partition
 Specifies the partitions in which the ISubscriber is active. More...
 
PresentationQosPolicy Presentation
 Specifies the dependency of changes to data-instances. More...
 
ShareQosPolicy Share
 Specifies if this ISubsscriber is shared subscriber More...
 

Detailed Description

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

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

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

QosPolicy Attribute <Default Value
SubscriberQos.EntityFactoryEntityFactoryQosPolicy.AutoEnableCreatedEntitiestrue
SubscriberQos.PartitionPartitionQosPolicy.Namenull
SubscriberQos.GroupDataGroupDataQosPolicy.Valueempty
SubscriberQos.PresentationPresentationQosPolicy.AccessScopeInstancePresentationQos
PresentationQosPolicy.CoherentAccessfalse
PresentationQosPolicy.OrderedAccessfalse
SubscriberQos.ShareShareQosPolicy.Enablefalse
ShareQosPolicy.Namenull
See also
Supported Quality of Service (QoS)

Definition at line 2426 of file DdsDcpsStructs.cs.

Member Data Documentation

◆ EntityFactory

EntityFactoryQosPolicy DDS.SubscriberQos.EntityFactory

Specifies whether a just created IDataReader should be enabled

For detailed information see Entity Factory QoS

Definition at line 2455 of file DdsDcpsStructs.cs.

◆ GroupData

GroupDataQosPolicy DDS.SubscriberQos.GroupData

Used to attach additional information to the ISubscriber.

For detailed information see Group Data QoS

Definition at line 2448 of file DdsDcpsStructs.cs.

◆ Partition

PartitionQosPolicy DDS.SubscriberQos.Partition

Specifies the partitions in which the ISubscriber is active.

For detailed information see Partition QoS

Definition at line 2441 of file DdsDcpsStructs.cs.

◆ Presentation

PresentationQosPolicy DDS.SubscriberQos.Presentation

Specifies the dependency of changes to data-instances.

For detailed information see Presentation QoS

Definition at line 2434 of file DdsDcpsStructs.cs.

◆ Share

ShareQosPolicy DDS.SubscriberQos.Share

Specifies if this ISubsscriber is shared subscriber

Note
Proprietary Policy

The Snare QoSPolicy is used to have several API ISubscriber entities to refer to the same underlying subscriber instance. When enables the Name attribute is used to combine the subscribers which have the same Name.

Definition at line 2466 of file DdsDcpsStructs.cs.

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