RTI Connext Java API  Version 5.3.1
 All Classes Namespaces Functions Variables Groups Pages
StatusKind Class Reference

Type for status kinds. More...

Static Public Attributes

static final int INCONSISTENT_TOPIC_STATUS
 Another topic exists with the same name but different characteristics.
 
static final int OFFERED_DEADLINE_MISSED_STATUS
 The deadline that the com.rti.dds.publication.DataWriter has committed through its com.rti.dds.infrastructure.DeadlineQosPolicy was not respected for a specific instance.
 
static final int REQUESTED_DEADLINE_MISSED_STATUS
 The deadline that the com.rti.dds.subscription.DataReader was expecting through its com.rti.dds.infrastructure.DeadlineQosPolicy was not respected for a specific instance.
 
static final int OFFERED_INCOMPATIBLE_QOS_STATUS
 A QosPolicy value was incompatible with what was requested.
 
static final int REQUESTED_INCOMPATIBLE_QOS_STATUS
 A QosPolicy value was incompatible with what is offered.
 
static final int SAMPLE_LOST_STATUS
 A sample has been lost (i.e. was never received).
 
static final int SAMPLE_REJECTED_STATUS
 A (received) sample has been rejected.
 
static final int DATA_ON_READERS_STATUS
 New data is available.
 
static final int DATA_AVAILABLE_STATUS
 One or more new data samples have been received.
 
static final int LIVELINESS_LOST_STATUS
 The liveliness that the com.rti.dds.publication.DataWriter has committed to through its com.rti.dds.infrastructure.LivelinessQosPolicy was not respected, thus com.rti.dds.subscription.DataReader entities will consider the com.rti.dds.publication.DataWriter as no longer alive.
 
static final int LIVELINESS_CHANGED_STATUS
 The liveliness of one or more com.rti.dds.publication.DataWriter that were writing instances read through the com.rti.dds.subscription.DataReader has changed. Some com.rti.dds.publication.DataWriter have become alive or not_alive.
 
static final int PUBLICATION_MATCHED_STATUS
 The com.rti.dds.publication.DataWriter has found com.rti.dds.subscription.DataReader that matches the com.rti.dds.topic.Topic and has compatible QoS.
 
static final int SUBSCRIPTION_MATCHED_STATUS
 The com.rti.dds.subscription.DataReader has found com.rti.dds.publication.DataWriter that matches the com.rti.dds.topic.Topic and has compatible QoS.
 
static final int SERVICE_REQUEST_ACCEPTED_STATUS
 <<extension>> A com.rti.dds.publication.DataWriter has been issued a com.rti.dds.topic.builtin.ServiceRequest
 
static final int DATA_WRITER_APPLICATION_ACKNOWLEDGMENT_STATUS
 <<extension>> A com.rti.dds.publication.DataWriter has received an application-level acknowledgment for a sample
 
static final int DATA_WRITER_INSTANCE_REPLACED_STATUS
 <<extension>> A com.rti.dds.publication.DataWriter instance has been replaced
 
static final int RELIABLE_WRITER_CACHE_CHANGED_STATUS
 <<extension>> The number of unacknowledged samples in a reliable writer's cache has changed such that it has reached a pre-defined trigger point.
 
static final int RELIABLE_READER_ACTIVITY_CHANGED_STATUS
 <<extension>> One or more reliable readers has become active or inactive.
 
static final int DDS_DATA_WRITER_CACHE_STATUS
 <<extension>> The status of the writer's cache.
 
static final int DDS_DATA_WRITER_PROTOCOL_STATUS
 <<extension>> The status of a writer's internal protocol related metrics
 
static final int DDS_DATA_READER_CACHE_STATUS
 <<extension>> The status of the reader's cache.
 
static final int DATA_READER_PROTOCOL_STATUS
 <<extension>> The status of a reader's internal protocol related metrics
 
static final int STATUS_MASK_NONE
 No bits are set.
 
static final int STATUS_MASK_ALL
 All bits are set.
 

Detailed Description

Type for status kinds.

Each concrete com.rti.dds.infrastructure.Entity is associated with a set of *Status objects whose values represent the communication status of that com.rti.dds.infrastructure.Entity.

The communication statuses whose changes can be communicated to the application depend on the com.rti.dds.infrastructure.Entity.

Each status value can be accessed with a corresponding method on the com.rti.dds.infrastructure.Entity. The changes on these status values cause activation of the corresponding com.rti.dds.infrastructure.StatusCondition objects and trigger invocation of the proper com.rti.dds.infrastructure.Listener objects to asynchronously inform the application. Note that not all statuses will activate the com.rti.dds.infrastructure.StatusCondition or have a corresponding listener callback. Refer to the documentation of the individual statuses for that information.

See Also
com.rti.dds.infrastructure.Entity, com.rti.dds.infrastructure.StatusCondition, com.rti.dds.infrastructure.Listener

Member Data Documentation

final int INCONSISTENT_TOPIC_STATUS
static

Another topic exists with the same name but different characteristics.

Entity:
com.rti.dds.topic.Topic
Status:
com.rti.dds.topic.InconsistentTopicStatus
Listener:
com.rti.dds.topic.TopicListener
final int OFFERED_DEADLINE_MISSED_STATUS
static
final int REQUESTED_DEADLINE_MISSED_STATUS
static
final int OFFERED_INCOMPATIBLE_QOS_STATUS
static
final int REQUESTED_INCOMPATIBLE_QOS_STATUS
static
final int SAMPLE_LOST_STATUS
static
final int SAMPLE_REJECTED_STATUS
static
final int DATA_ON_READERS_STATUS
static
final int DATA_AVAILABLE_STATUS
static

One or more new data samples have been received.

Entity:
com.rti.dds.subscription.DataReader
Listener:
com.rti.dds.subscription.DataReaderListener
final int LIVELINESS_LOST_STATUS
static
final int LIVELINESS_CHANGED_STATUS
static

The liveliness of one or more com.rti.dds.publication.DataWriter that were writing instances read through the com.rti.dds.subscription.DataReader has changed. Some com.rti.dds.publication.DataWriter have become alive or not_alive.

Entity:
com.rti.dds.subscription.DataReader
QoS:
LIVELINESS
Status:
com.rti.dds.subscription.LivelinessChangedStatus
Listener:
com.rti.dds.subscription.DataReaderListener
final int SERVICE_REQUEST_ACCEPTED_STATUS
static
final int DATA_WRITER_APPLICATION_ACKNOWLEDGMENT_STATUS
static

<<extension>> A com.rti.dds.publication.DataWriter has received an application-level acknowledgment for a sample

Enables a com.rti.dds.publication.DataWriter callback that is called when an application-level acknowledgment from a com.rti.dds.subscription.DataReader is received. The callback is called for each sample that is application-level acknowledged. Changes to this status do not trigger a com.rti.dds.infrastructure.StatusCondition.

Entity:
com.rti.dds.publication.DataWriter
Listener:
com.rti.dds.publication.DataWriterListener
final int DATA_WRITER_INSTANCE_REPLACED_STATUS
static

<<extension>> A com.rti.dds.publication.DataWriter instance has been replaced

Enables a com.rti.dds.publication.DataWriter callback that is called when an instance in the writer queue is replaced.

Entity:
com.rti.dds.publication.DataWriter
Listener:
com.rti.dds.publication.DataWriterListener
final int RELIABLE_WRITER_CACHE_CHANGED_STATUS
static

<<extension>> The number of unacknowledged samples in a reliable writer's cache has changed such that it has reached a pre-defined trigger point.

This status is considered changed at the following times: the cache is empty (i.e. contains no unacknowledge samples), full (i.e. the sample count has reached the value specified in com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples), or the number of samples has reached a high (see com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.high_watermark) or low (see com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.low_watermark) watermark.

Entity:
com.rti.dds.publication.DataWriter
Status:
com.rti.dds.publication.ReliableWriterCacheChangedStatus
Listener:
com.rti.dds.publication.DataWriterListener
final int RELIABLE_READER_ACTIVITY_CHANGED_STATUS
static

<<extension>> One or more reliable readers has become active or inactive.

A reliable reader is considered active by a reliable writer with which it is matched if that reader acknowledges the samples it has been sent in a timely fashion. For the definition of "timely" in this case, see com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t and com.rti.dds.publication.ReliableReaderActivityChangedStatus.

See Also
com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t
com.rti.dds.publication.ReliableReaderActivityChangedStatus
final int DDS_DATA_WRITER_CACHE_STATUS
static

<<extension>> The status of the writer's cache.

Changes to this status do not trigger a com.rti.dds.infrastructure.StatusCondition.

final int DDS_DATA_WRITER_PROTOCOL_STATUS
static

<<extension>> The status of a writer's internal protocol related metrics

The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic. Changes to this status do not trigger a com.rti.dds.infrastructure.StatusCondition.

final int DDS_DATA_READER_CACHE_STATUS
static

<<extension>> The status of the reader's cache.

Changes to this status do not trigger a com.rti.dds.infrastructure.StatusCondition.

final int DATA_READER_PROTOCOL_STATUS
static

<<extension>> The status of a reader's internal protocol related metrics

The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic. Changes to this status do not trigger a com.rti.dds.infrastructure.StatusCondition.


RTI Connext Java API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc