RTI Connext Modern C++ API  Version 5.2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::core::policy::Ownership Class Reference

Specifies whether it is allowed for multiple dds::pub::DataWriter's to write the same instance of the data and if so, how these modifications should be arbitrated. More...

#include <dds/core/policy/CorePolicy.hpp>

Public Member Functions

 Ownership ()
 Creates an ownership policy set to shared.
 
 Ownership (dds::core::policy::OwnershipKind the_kind)
 Creates an instance with the specified ownership kind.
 
Ownershipkind (dds::core::policy::OwnershipKind the_kind)
 Sets the ownership kind.
 
dds::core::policy::OwnershipKind kind () const
 Getter (see setter with the same name)
 

Static Public Member Functions

static Ownership Exclusive ()
 Creates a Ownership instance with exclusive kind.
 
static Ownership Shared ()
 Creates a Ownership instance with shared kind.
 

Detailed Description

Specifies whether it is allowed for multiple dds::pub::DataWriter's to write the same instance of the data and if so, how these modifications should be arbitrated.

Entity:
dds::topic::Topic, dds::sub::DataReader, dds::pub::DataWriter
Status:
dds::core::status::StatusMask::offered_incompatible_qos(), dds::core::status::StatusMask::requested_incompatible_qos()
Properties:
RxO = YES
Changeable = UNTIL ENABLE
See Also
OWNERSHIP_STRENGTH

Usage

Along with the OWNERSHIP_STRENGTH, this QoS policy specifies if dds::sub::DataReader entities can receive updates to the same instance (identified by its key) from multiple dds::pub::DataWriter entities at the same time.

There are two kinds of ownership, selected by the setting of the kind: SHARED and EXCLUSIVE.

SHARED ownership

dds::core::policy::OwnershipKind_def::SHARED indicates that RTI Connext does not enforce unique ownership for each instance. In this case, multiple writers can update the same data type instance. The subscriber to the dds::topic::Topic will be able to access modifications from all dds::pub::DataWriter objects, subject to the settings of other QoS that may filter particular samples (e.g. the TIME_BASED_FILTER or HISTORY policy). In any case, there is no "filtering" of modifications made based on the identity of the dds::pub::DataWriter that causes the modification.

EXCLUSIVE ownership

dds::core::policy::OwnershipKind_def::EXCLUSIVE indicates that each instance of a data type can only be modified by one dds::pub::DataWriter. In other words, at any point in time, a single dds::pub::DataWriter owns each instance and is the only one whose modifications will be visible to the dds::sub::DataReader objects. The owner is determined by selecting the dds::pub::DataWriter with the highest value of the dds::core::policy::OwnershipStrength::value that is currently alive, as defined by the LIVELINESS policy, and has not violated its DEADLINE contract with regards to the data instance.

Ownership can therefore change as a result of:

The behavior of the system is as if the determination was made independently by each dds::sub::DataReader. Each dds::sub::DataReader may detect the change of ownership at a different time. It is not a requirement that at a particular point in time all the dds::sub::DataReader objects for that dds::topic::Topic have a consistent picture of who owns each instance.

It is also not a requirement that the dds::pub::DataWriter objects are aware of whether they own a particular instance. There is no error or notification given to a dds::pub::DataWriter that modifies an instance it does not currently own.

The requirements are chosen to (a) preserve the decoupling of publishers and subscriber, and (b) allow the policy to be implemented efficiently.

It is possible that multiple dds::pub::DataWriter objects with the same strength modify the same instance. If this occurs RTI Connext will pick one of the dds::pub::DataWriter objects as the owner. It is not specified how the owner is selected. However, the algorithm used to select the owner guarantees that all dds::sub::DataReader objects will make the same choice of the particular dds::pub::DataWriter that is the owner. It also guarantees that the owner remains the same until there is a change in strength, liveliness, the owner misses a deadline on the instance, or a new dds::pub::DataWriter with higher same strength, or a new dds::pub::DataWriter with same strength that should be deemed the owner according to the policy of the Service, modifies the instance.

Exclusive ownership is on an instance-by-instance basis. That is, a subscriber can receive values written by a lower strength dds::pub::DataWriter as long as they affect instances whose values have not been set by the higher-strength dds::pub::DataWriter.

Compatibility

The value of the dds::core::policy::OwnershipKind_def offered must exactly match the one requested or else they are considered incompatible.

Relationship between registration, liveliness and ownership \endif <P> The need for registering/unregistering instances stems from two use cases: \li Ownership resolution on redundant systems <P> \li Detection of loss in topological connectivity <P> These two use cases also illustrate the semantic differences between the dds::pub::DataWriter::unregister_instance and dds::pub::DataWriter::dispose_instance(). <P> \ifnot BROKEN_SECTIONS @subsection Ownership_redundant_systems Ownership Resolution on Redundant Systems

It is expected that users may use DDS to set up redundant systems where multiple dds::pub::DataWriter entities are "capable" of writing the same instance. In this situation, the dds::pub::DataWriter entities are configured such that:

  • Either both are writing the instance "constantly"
  • Or else they use some mechanism to classify each other as "primary" and "secondary", such that the primary is the only one writing, and the secondary monitors the primary and only writes when it detects that the primary "writer" is no longer writing.

Both cases above use the dds::core::policy::OwnershipKind_def::EXCLUSIVE and arbitrate themselves by means of the dds::core::policy::OwnershipStrength. Regardless of the scheme, the desired behavior from the dds::sub::DataReader point of view is that dds::sub::DataReader normally receives data from the primary unless the "primary" writer stops writing, in which case the dds::sub::DataReader starts to receive data from the secondary dds::pub::DataWriter.

This approach requires some mechanism to detect that a dds::pub::DataWriter (the primary) is no longer "writing" the data as it should. There are several reasons why this may happen and all must be detected (but not necessarily distinguished):

  • [crash] The writing process is no longer running (e.g. the whole application has crashed)
  • [connectivity loss] Connectivity to the writing application has been lost (e.g. network disconnection)

Arbitrating from a dds::pub::DataWriter to one of a higher strength is simple and the decision can be taken autonomously by the dds::sub::DataReader. Switching ownership from a higher strength dds::pub::DataWriter to one of a lower strength dds::pub::DataWriter requires that the dds::sub::DataReader can make a determination that the stronger dds::pub::DataWriter is "no longer writing the instance".

Constructor & Destructor Documentation

dds::core::policy::Ownership::Ownership ( )
inline

Creates an ownership policy set to shared.

dds::core::policy::Ownership::Ownership ( dds::core::policy::OwnershipKind  the_kind)
inlineexplicit

Creates an instance with the specified ownership kind.

Member Function Documentation

Ownership& dds::core::policy::Ownership::kind ( dds::core::policy::OwnershipKind  the_kind)
inline

Sets the ownership kind.

[default] dds::core::policy::OwnershipKind_def::SHARED

dds::core::policy::OwnershipKind dds::core::policy::Ownership::kind ( ) const
inline

Getter (see setter with the same name)

static Ownership dds::core::policy::Ownership::Exclusive ( )
inlinestatic

Creates a Ownership instance with exclusive kind.

static Ownership dds::core::policy::Ownership::Shared ( )
inlinestatic

Creates a Ownership instance with shared kind.


RTI Connext Modern C++ API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc