Rti.Dds.Core.Status Namespace Reference

Contains the Status classes More...

Classes
class	DataReaderCacheStatus
	The status of the reader's cache. More...
class	DataReaderProtocolStatus
	The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic. More...
class	DataWriterCacheStatus
	The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue. More...
class	DataWriterProtocolStatus
	The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic. More...
class	DomainParticipantProtocolStatus
	The status of a participant's protocol related metrics, like the number of corrupted messages, change in corrupted messages and timestamp of the last corrupted message. More...
class	InconsistentTopicStatus
	Notifies of a change in the StatusMask.InconsistentTopic status More...
class	LivelinessChangedStatus
	Indicates that the liveliness of one or more matched Publication.DataWriter<T> has changed. More...
class	LivelinessLostStatus
	The liveliness that the Publication.DataWriter<T> has committed to through its Policy.Liveliness was not respected, thus Subscription.DataReader<T> entities will consider the Publication.DataWriter<T> as no longer alive. More...
class	OfferedDeadlineMissedStatus
	Notifies of a change in the StatusMask.OfferedDeadlineMissed status More...
class	OfferedIncompatibleQosStatus
	A QosPolicy value was incompatible with what was requested. More...
class	PublicationMatchedStatus
	Notifies of a change in the StatusMask.PublicationMatched status More...
class	ReliableReaderActivityChangedStatus
	Describes the activity (i.e. are acknowledgements forthcoming) of reliable readers matched to a reliable writer. More...
class	ReliableWriterCacheChangedStatus
	A summary of the state of a data writer's cache of unacknowledged samples written. More...
class	RequestedDeadlineMissedStatus
	Indicates that the Subscription.DataReader<T> did not receive a new sample for an data-instance within the time period set in the Subscription.DataReader<T>'s Policy.Deadline. More...
class	RequestedIncompatibleQosStatus
	Indicates that the Subscription.DataReader<T> discovered a Publication.DataWriter<T> for the same Topics.Topic<T>, but that Subscription.DataReader<T> had requested QoS settings incompatible with the ones offered by the Publication.DataWriter<T>. More...
class	SampleLostStatus
	Indicates that one or more samples written by a matched Publication.DataWriter<T> have failed to be received by the Subscription.DataReader<T>. More...
class	SampleRejectedStatus
	Indicates that one or more samples received from a matched Publication.DataWriter<T> have been rejected by the Subscription.DataReader<T> because a resource limit would have been exceeded. More...
class	ServiceRequestAcceptedStatus
	Notifies of a change in the StatusMask.ServiceRequestAccepted status. More...
class	SubscriptionMatchedStatus
	Indicates that the Subscription.DataReader<T> discovered a matching Publication.DataWriter<T>. More...

Enumerations
enum class	SampleLostStatusKind : int {   NotLost ,   LostByWriter ,   LostByInstancesLimit ,   LostByRemoteWritersPerInstanceLimit ,   LostByIncompleteCoherentSet ,   LostByLargeCoherentSet ,   LostBySamplesPerRemoteWriterLimit ,   LostByVirtualWritersLimit ,   LostByRemoteWritersPerSampleLimit ,   LostByAvailabilityWaitingTime ,   LostByRemoteWriterSamplesPerVirtualQueueLimit ,   LostByOutOfMemory ,   LostByUnknownInstance ,   LostByDeserializationFailure ,   LostByDecodeFailure ,   LostBySamplesPerInstanceLimit ,   LostBySamplesLimit }
	Represents the reason why a sample written by a matched Publication.DataWriter<T> have failed to be received by the Subscription.DataReader<T>. More...
enum class	SampleRejectedStatusKind : int {   NotRejected ,   RejectedByInstancesLimit ,   RejectedBySamplesLimit ,   RejectedBySamplesPerInstanceLimit ,   RejectedBySamplesPerRemoteWriterLimit ,   RejectedByRemoteWriterSamplesPerVirtualQueueLimit ,   RejectedByDecodeFailure }
	Represents the reason why a sample may have been rejected by the Subscription.DataReader<T>. More...
enum class	StatusMask : uint {   None ,   InconsistentTopic ,   OfferedDeadlineMissed ,   RequestedDeadlineMissed ,   OfferedIncompatibleQos ,   RequestedIncompatibleQos ,   SampleLost ,   SampleRejected ,   DataOnReaders ,   DataAvailable ,   LivelinessLost ,   LivelinessChanged ,   PublicationMatched ,   SubscriptionMatched ,   ServiceRequestAccepted ,   DataWriterApplicationAcknowledgementReceived ,   DataWriterInstanceReplaced ,   ReliableWriterCacheChanged ,   ReliableReaderActivityChanged ,   DataWriterCache ,   DataWriterProtocol ,   DataReaderCache ,   DataReaderProtocol ,   DataWriterSampleRemoved ,   All }
	Each flag identifies a Entity status. More...

Detailed Description

Contains the Status classes

Enumeration Type Documentation

SampleLostStatusKind

enum SampleLostStatusKind : int

strong

Represents the reason why a sample written by a matched Publication.DataWriter<T> have failed to be received by the Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_SampleLostStatusKind

Enumerator
NotLost	The sample was not lost.
LostByWriter	A Publication.DataWriter<T> removed the sample before being received by the Subscription.DataReader<T>.
LostByInstancesLimit	A resource limit on the number of instances was reached.
LostByRemoteWritersPerInstanceLimit	A resource limit on the number of remote writers for a single instance from which a Subscription.DataReader<T> may read was reached.
LostByIncompleteCoherentSet	A sample was lost because it was part of an incomplete coherent set. An incomplete coherent set is a coherent set for which some of the samples are missing.
LostByLargeCoherentSet	A sample was lost because it was part of a large coherent set.
LostBySamplesPerRemoteWriterLimit	A resource limit on the number of samples from a given remote writer that a Subscription.DataReader<T> may store was reached.
LostByVirtualWritersLimit	A resource limit on the number of virtual writers from which a Subscription.DataReader<T> may read was reached.
LostByRemoteWritersPerSampleLimit	A resource limit on the number of remote writers per sample was reached.
LostByAvailabilityWaitingTime	Policy.Availability.MaxDataAvailabilityWaitingTime expired.
LostByRemoteWriterSamplesPerVirtualQueueLimit	A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a Subscription.DataReader<T> may store was reached.
LostByOutOfMemory	A sample was lost because there was not enough memory to store the sample.
LostByUnknownInstance	A received sample was lost because it doesn't contain enough information for the Subscription.DataReader<T> to know what instance it is associated with.
LostByDeserializationFailure	A received sample was lost because it could not be deserialized.
LostByDecodeFailure	When using Policy.ReliabilityKind.BestEffort: A received sample was lost because it could not be decoded.
LostBySamplesPerInstanceLimit	When using Policy.ReliabilityKind.BestEffort: A resource limit on the number of samples per instance (Policy.ResourceLimits.MaxSamplesPerInstance) was reached.
LostBySamplesLimit	When using Policy.ReliabilityKind.BestEffort: A resource limit on the number of samples (Policy.ResourceLimits.MaxSamples) was reached.

SampleRejectedStatusKind

enum SampleRejectedStatusKind : int

strong

Represents the reason why a sample may have been rejected by the Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_SampleRejectedStatusKind

Enumerator
NotRejected	Sample was accepted.
RejectedByInstancesLimit	A resource limit on the number of instances that can be handled at the same time by the Subscription.DataReader<T> was reached.
RejectedBySamplesLimit	A resource limit on the total number of samples was reached.
RejectedBySamplesPerInstanceLimit	A resource limit on the number of samples per instance was reached.
RejectedBySamplesPerRemoteWriterLimit	A resource limit on the number of samples that a Subscription.DataReader<T> may store from a specific Publication.DataWriter<T> was reached.
RejectedByRemoteWriterSamplesPerVirtualQueueLimit	A resource limit on the number of samples published by a remote Publication.DataWriter<T> on behalf of a virtual writer that a Subscription.DataReader<T> may store was reached.
RejectedByDecodeFailure	Failure to decode the sample by the Subscription.DataReader<T>.

StatusMask

enum StatusMask : uint

strong

Each flag identifies a Entity status.

Enumerator
None	A mask with no status.
InconsistentTopic	Another topic exists with the same name but different characteristics. The full documentation is available in the C API: DDS_INCONSISTENT_TOPIC_STATUS
OfferedDeadlineMissed	The deadline that the Publication.DataWriter<T> has committed through its Policy.Deadline policy was not respected for a specific instance. The full documentation is available in the C API: DDS_OFFERED_DEADLINE_MISSED_STATUS
RequestedDeadlineMissed	The deadline that the Subscription.DataReader<T> was expecting through its Policy.Deadline was not respected for a specific instance. The full documentation is available in the C API: DDS_REQUESTED_DEADLINE_MISSED_STATUS
OfferedIncompatibleQos	A Qos policy value was incompatible with what was requested. The full documentation is available in the C API: DDS_OFFERED_INCOMPATIBLE_QOS_STATUS
RequestedIncompatibleQos	A Qos policy value was incompatible with what is offered. The full documentation is available in the C API: DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS
SampleLost	A sample has been lost (i.e. was never received). The full documentation is available in the C API: DDS_SAMPLE_LOST_STATUS
SampleRejected	A (received) sample has been rejected. The full documentation is available in the C API: DDS_SAMPLE_REJECTED_STATUS
DataOnReaders	New data is available. The full documentation is available in the C API: DDS_DATA_ON_READERS_STATUS
DataAvailable	One or more new data samples have been received. The full documentation is available in the C API: DDS_DATA_AVAILABLE_STATUS
LivelinessLost	The liveliness that the Publication.DataWriter<T> has committed to through its Policy.Liveliness was not respected, thus Subscription.DataReader<T> entities will consider the Publication.DataWriter<T> as no longer alive. The full documentation is available in the C API: DDS_LIVELINESS_LOST_STATUS
LivelinessChanged	The liveliness of one or more Publication.DataWriter<T> that were writing instances read through the Subscription.DataReader<T> has changed. Some Publication.DataWriter<T> have become alive or not_alive. The full documentation is available in the C API: DDS_LIVELINESS_CHANGED_STATUS
PublicationMatched	The Publication.DataWriter<T> has found Subscription.DataReader<T> that matches the Topics.Topic<T> and has compatible QoS. The full documentation is available in the C API: DDS_PUBLICATION_MATCHED_STATUS
SubscriptionMatched	The Subscription.DataReader<T> has found Publication.DataWriter<T> that matches the Topics.Topic<T> and has compatible QoS. The full documentation is available in the C API: DDS_SUBSCRIPTION_MATCHED_STATUS
ServiceRequestAccepted	A service request has been received for a Publication.DataWriter<T>. The full documentation is available in the C API: DDS_SERVICE_REQUEST_ACCEPTED_STATUS
DataWriterApplicationAcknowledgementReceived	A Publication.DataWriter<T> has received an application-level acknowledgment for a sample. The full documentation is available in the C API: DDS_DATA_WRITER_APPLICATION_ACKNOWLEDGMENT_STATUS
DataWriterInstanceReplaced	A Publication.DataWriter<T> instance has been replaced. The full documentation is available in the C API: DDS_DATA_WRITER_INSTANCE_REPLACED_STATUS
ReliableWriterCacheChanged	The number of unacknowledged samples in a reliable writer's cache has changed and reached a pre-defined trigger point. The full documentation is available in the C API: DDS_RELIABLE_WRITER_CACHE_CHANGED_STATUS
ReliableReaderActivityChanged	One or more reliable readers has become active or inactive. The full documentation is available in the C API: DDS_RELIABLE_READER_ACTIVITY_CHANGED_STATUS
DataWriterCache	The status of the writer's cache. The full documentation is available in the C API: DDS_DATA_WRITER_CACHE_STATUS
DataWriterProtocol	The status of a writer's internal protocol related metrics. The full documentation is available in the C API: DDS_DATA_WRITER_PROTOCOL_STATUS
DataReaderCache	The status of the reader's cache. The full documentation is available in the C API: DDS_DATA_READER_CACHE_STATUS
DataReaderProtocol	The status of a reader's internal protocol related metrics. The full documentation is available in the C API: DDS_DATA_READER_PROTOCOL_STATUS
DataWriterSampleRemoved	A sample has been removed from a Publication.DataWriter<T>. The full documentation is available in the C API: DDS_DATA_WRITER_SAMPLE_REMOVED_STATUS
All	A mask with all statuses