|
RTI Connext .NET API (legacy)
Version 6.1.2
|
Specifies whether it is allowed for multiple DDS::DataWriter (s) to write the same instance of the data and if so, how these modifications should be arbitrated. More...
#include <managed_infrastructure.h>
Static Public Member Functions | |
| static System::String ^ | get_ownership_qos_policy_name () |
| Stringified human-readable name for DDS::OwnershipQosPolicy. More... | |
Public Attributes | |
| OwnershipQosPolicyKind | kind |
| The kind of ownership. More... | |
Specifies whether it is allowed for multiple DDS::DataWriter (s) to write the same instance of the data and if so, how these modifications should be arbitrated.
Along with the OWNERSHIP_STRENGTH, this QoS policy specifies if DDS::DataReader entities can receive updates to the same instance (identified by its key) from multiple DDS::DataWriter entities at the same time.
There are two kinds of ownership, selected by the setting of the kind: SHARED and EXCLUSIVE.
DDS::OwnershipQosPolicyKind::SHARED_OWNERSHIP_QOS 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 will be able to access modifications from all DDS::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::DataWriter that causes the modification.
DDS::OwnershipQosPolicyKind::EXCLUSIVE_OWNERSHIP_QOS indicates that each instance of a data type can only be modified by one DDS::DataWriter. In other words, at any point in time, a single DDS::DataWriter owns each instance and is the only one whose modifications will be visible to the DDS::DataReader objects. The owner is determined by selecting the DDS::DataWriter with the highest value of the DDS::OwnershipStrengthQosPolicy::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::DataReader. Each DDS::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::DataReader objects for that DDS::Topic have a consistent picture of who owns each instance.
It is also not a requirement that the DDS::DataWriter objects are aware of whether they own a particular instance. There is no error or notification given to a DDS::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::DataWriter objects with the same strength modify the same instance. If this occurs RTI Connext will pick one of the DDS::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::DataReader objects will make the same choice of the particular DDS::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::DataWriter with higher same strength, or a new DDS::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::DataWriter as long as they affect instances whose values have not been set by the higher-strength DDS::DataWriter.
The value of the DDS::OwnershipQosPolicyKind offered must exactly match the one requested or else they are considered incompatible.
The need for registering/unregistering instances stems from two use cases:
These two use cases also illustrate the semantic differences between the DDS::TypedDataWriter::unregister_instance and DDS::TypedDataWriter::dispose.
It is expected that users may use DDS to set up redundant systems where multiple DDS::DataWriter entities are "capable" of writing the same instance. In this situation, the DDS::DataWriter entities are configured such that:
Both cases above use the DDS::OwnershipQosPolicyKind::EXCLUSIVE_OWNERSHIP_QOS and arbitrate themselves by means of the DDS::OwnershipStrengthQosPolicy. Regardless of the scheme, the desired behavior from the DDS::DataReader point of view is that DDS::DataReader normally receives data from the primary unless the "primary" writer stops writing, in which case the DDS::DataReader starts to receive data from the secondary DDS::DataWriter.
This approach requires some mechanism to detect that a DDS::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):
Arbitrating from a DDS::DataWriter to one of a higher strength is simple and the decision can be taken autonomously by the DDS::DataReader. Switching ownership from a higher strength DDS::DataWriter to one of a lower strength DDS::DataWriter requires that the DDS::DataReader can make a determination that the stronger DDS::DataWriter is "no longer writing the instance".
This determination is reasonably simple when the data is being written periodically at some rate. The DDS::DataWriter simply states its offered DDS::DeadlineQosPolicy (maximum interval between updates) and the DDS::DataReader automatically monitors that the DDS::DataWriter indeed updates the instance at least once per DDS::DeadlineQosPolicy::period. If the deadline is missed, the DDS::DataReader considers the DDS::DataWriter "not alive" and automatically gives ownership to the next highest-strength DDS::DataWriter that is alive.
The case where the DDS::DataWriter is not writing data periodically is also a very important use-case. Since the instance is not being updated at any fixed period, the "deadline" mechanism cannot be used to determine ownership. The liveliness solves this situation. Ownership is maintained while the DDS::DataWriter is "alive" and for the DDS::DataWriter to be alive it must fulfill its DDS::LivelinessQosPolicy contract. The different means to renew liveliness (automatic, manual) combined by the implied renewal each time data is written handle the three conditions above [crash], [connectivity loss], and [application fault]. Note that to handle [application fault], LIVELINESS must be MANUAL_BY_TOPIC_LIVELINESS_QOS. The DDS::DataWriter can retain ownership by periodically writing data or else calling assert_liveliness if it has no data to write. Alternatively if only protection against [crash] or [connectivity loss] is desired, it is sufficient that some task on the DDS::DataWriter process periodically writes data or calls DDS::DomainParticipant::assert_liveliness. However, this scenario requires that the DDS::DataReader knows what instances are being "written" by the DDS::DataWriter. That is the only way that the DDS::DataReader deduces the ownership of specific instances from the fact that the DDS::DataWriter is still "alive". Hence the need for the DDS::DataWriter to "register" and "unregister" instances. Note that while "registration" can be done lazily the first time the DDS::DataWriter writes the instance, "unregistration," in general, cannot. Similar reasoning will lead to the fact that unregistration will also require a message to be sent to the DDS::DataReader.
There are applications that are designed in such a way that their correct operation requires some minimal topological connectivity, that is, the writer needs to have a minimum number of readers or alternatively the reader must have a minimum number of writers.
A common scenario is that the application does not start doing its logic until it knows that some specific writers have the minimum configured readers (e.g the alarm monitor is up).
A more common scenario is that the application logic will wait until some writers appear that can provide some needed source of information (e.g. the raw sensor data that must be processed).
Furthermore, once the application is running it is a requirement that this minimal connectivity (from the source of the data) is monitored and the application informed if it is ever lost. For the case where data is being written periodically, the DDS::DeadlineQosPolicy and the on_deadline_missed listener provides the notification. The case where data is not periodically updated requires the use of the DDS::LivelinessQosPolicy in combination with register_instance/unregister_instance to detect whether the "connectivity" has been lost, and the notification is provided by means of DDS::InstanceStateKind::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE.
In terms of the required mechanisms, the scenario is very similar to the case of maintaining ownership. In both cases, the reader needs to know whether a writer is still "managing the current value of an instance" even though it is not continually writing it and this knowledge requires the writer to keep its liveliness plus some means to know which instances the writer is currently "managing" (i.e. the registered instances).
DDS::TypedDataWriter::dispose is semantically different from DDS::TypedDataWriter::unregister_instance. DDS::TypedDataWriter::dispose indicates that the data instance no longer exists (e.g. a track that has disappeared, a simulation entity that has been destroyed, a record entry that has been deleted, etc.) whereas DDS::TypedDataWriter::unregister_instance indicates that the writer is no longer taking responsibility for updating the value of the instance.
Deleting a DDS::DataWriter is equivalent to unregistering all the instances it was writing, but is not the same as "disposing" all the instances.
For a DDS::Topic with DDS::OwnershipQosPolicyKind::EXCLUSIVE_OWNERSHIP_QOS, if the current owner of an instance disposes it, the readers accessing the instance will see the instance_state as being "DISPOSED" and not see the values being written by the weaker writer (even after the stronger one has disposed the instance). This is because the DDS::DataWriter that owns the instance is saying that the instance no longer exists (e.g. the master of the database is saying that a record has been deleted) and thus the readers should see it as such.
For a DDS::Topic with DDS::OwnershipQosPolicyKind::EXCLUSIVE_OWNERSHIP_QOS, if the current owner of an instance unregisters it, then it will relinquish ownership of the instance and thus the readers may see the value updated by another writer (which will then become the owner). This is because the owner said that it no longer will be providing values for the instance and thus another writer can take ownership and provide those values.
| OwnershipQosPolicyKind DDS::OwnershipQosPolicy::kind |
The kind of ownership.