RTI Connext Java API Version 7.1.0
SampleLostStatusKind Class Reference

<<extension>> Kinds of reasons why a sample was lost. More...

Inheritance diagram for SampleLostStatusKind:
Enum Copyable

Static Public Attributes

static final SampleLostStatusKind NOT_LOST
 The sample was not lost. More...
 
static final SampleLostStatusKind LOST_BY_WRITER
 A com.rti.dds.publication.DataWriter removed the sample before being received by the com.rti.dds.subscription.DataReader. More...
 
static final SampleLostStatusKind LOST_BY_INSTANCES_LIMIT
 A resource limit on the number of instances (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_instances) was reached. More...
 
static final SampleLostStatusKind LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT
 A resource limit on the number of remote writers for a single instance from which a com.rti.dds.subscription.DataReader may read (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_writers_per_instance) was reached. More...
 
static final SampleLostStatusKind LOST_BY_INCOMPLETE_COHERENT_SET
 A sample is lost because it is part of an incomplete coherent set. An incomplete coherent set is a coherent set for which some of the samples are missing. More...
 
static final SampleLostStatusKind LOST_BY_LARGE_COHERENT_SET
 A sample is lost because it is part of a large coherent set. A large coherent set is a coherent set that cannot fit all at once into the com.rti.dds.subscription.DataReader queue because resource limits are exceeded. More...
 
static final SampleLostStatusKind LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT
 When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: a resource limit on the number of samples from a given remote writer that a com.rti.dds.subscription.DataReader may store (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_samples_per_remote_writer) was reached. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, reaching com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_samples_per_remote_writer will trigger a rejection, not a loss, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT. More...
 
static final SampleLostStatusKind LOST_BY_VIRTUAL_WRITERS_LIMIT
 A resource limit on the number of virtual writers from which a com.rti.dds.subscription.DataReader may read (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_virtual_writers) was reached. More...
 
static final SampleLostStatusKind LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT
 A resource limit on the number of remote writers per sample (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_writers_per_sample) was reached. More...
 
static final SampleLostStatusKind LOST_BY_AVAILABILITY_WAITING_TIME
 com.rti.dds.infrastructure.AvailabilityQosPolicy.max_data_availability_waiting_time expired. More...
 
static final SampleLostStatusKind LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT
 A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a com.rti.dds.subscription.DataReader may store was reached. (This field is currently not used.) More...
 
static final SampleLostStatusKind LOST_BY_OUT_OF_MEMORY
 A sample was lost because there was not enough memory to store the sample. More...
 
static final SampleLostStatusKind LOST_BY_UNKNOWN_INSTANCE
 A received sample was lost because it doesn't contain enough information for the reader to know what instance it is associated with. More...
 
static final SampleLostStatusKind LOST_BY_DESERIALIZATION_FAILURE
 A received sample was lost because it could not be deserialized. More...
 
static final SampleLostStatusKind LOST_BY_DECODE_FAILURE
 When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A received sample was lost because it could not be decoded. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, the sample will be rejected, not lost, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_DECODE_FAILURE. More...
 
static final SampleLostStatusKind LOST_BY_SAMPLES_PER_INSTANCE_LIMIT
 When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A resource limit on the number of samples per instance (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance) was reached. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, reaching com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance will trigger a rejection, not a loss, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT. More...
 
static final SampleLostStatusKind LOST_BY_SAMPLES_LIMIT
 When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A resource limit on the number of samples (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples) was reached. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, reaching com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples will trigger a rejection, not a loss, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_SAMPLES_LIMIT. More...
 

Additional Inherited Members

- Public Member Functions inherited from Enum
final int ordinal ()
 The integral value of this enumerated constant. More...
 
Object copy_from (Object src)
 
final String name ()
 The name of this enum constant, as declared in the enum declaration. More...
 
final String toString ()
 The string value of this enum constant. More...
 
Object copy_from (Object src)
 Copy value of a data type from source. More...
 
- Protected Member Functions inherited from Enum
 Enum (String name, int ordinal)
 The constructor. More...
 
final Object clone () throws CloneNotSupportedException
 

Detailed Description

<<extension>> Kinds of reasons why a sample was lost.

Member Data Documentation

◆ NOT_LOST

final SampleLostStatusKind NOT_LOST
static
Initial value:
= new com.rti.dds.subscription.SampleLostStatusKind(
"NOT_LOST", 0)

The sample was not lost.

This constant is an extension to the DDS standard. MONITOR-273 We assign an integer to the names in order to be compatible with the DDSMonitoring types. If new values are added, update DataReaderTest.testGetAndSetSampleLostStatus

◆ LOST_BY_WRITER

final SampleLostStatusKind LOST_BY_WRITER
static
Initial value:
= new com.rti.dds.subscription.SampleLostStatusKind(
"LOST_BY_WRITER", 1)

A com.rti.dds.publication.DataWriter removed the sample before being received by the com.rti.dds.subscription.DataReader.

This constant is an extension to the DDS standard.

◆ LOST_BY_INSTANCES_LIMIT

final SampleLostStatusKind LOST_BY_INSTANCES_LIMIT
static
Initial value:
= new com.rti.dds.subscription.SampleLostStatusKind(
"LOST_BY_INSTANCES_LIMIT", 2)

A resource limit on the number of instances (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_instances) was reached.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.ResourceLimitsQosPolicy

◆ LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT

final SampleLostStatusKind LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT", 3)

A resource limit on the number of remote writers for a single instance from which a com.rti.dds.subscription.DataReader may read (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_writers_per_instance) was reached.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

◆ LOST_BY_INCOMPLETE_COHERENT_SET

final SampleLostStatusKind LOST_BY_INCOMPLETE_COHERENT_SET
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_INCOMPLETE_COHERENT_SET", 4)

A sample is lost because it is part of an incomplete coherent set. An incomplete coherent set is a coherent set for which some of the samples are missing.

For example, consider a com.rti.dds.publication.DataWriter using com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP_LAST_HISTORY_QOS with a depth of 1. The DataWriter publishes two samples of the same instance as part of a coherent set 'CS1'; the first sample of 'CS1' is replaced by a new sample before it can be successfully delivered to the com.rti.dds.subscription.DataReader. In this case, the coherent set containing the two samples is considered incomplete. The new sample, by default, will not be provided to the application, and will be reported as LOST_BY_INCOMPLETE_COHERENT_SET. (You can change this default behavior by setting com.rti.dds.infrastructure.PresentationQosPolicy.drop_incomplete_coherent_set to FALSE. If you do, the new sample will be provided to the application, but it will be marked as part of an incomplete coherent set in the com.rti.dds.subscription.SampleInfo structure.)

This constant is an extension to the DDS standard.

◆ LOST_BY_LARGE_COHERENT_SET

final SampleLostStatusKind LOST_BY_LARGE_COHERENT_SET
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_LARGE_COHERENT_SET", 5)

A sample is lost because it is part of a large coherent set. A large coherent set is a coherent set that cannot fit all at once into the com.rti.dds.subscription.DataReader queue because resource limits are exceeded.

For example, if com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance on the DataReader is 10 and the coherent set has 15 samples for a given instance, the coherent set is a large coherent set that will be considered incomplete.

The resource limits that can lead to large coherent sets are: com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples, com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance, com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_instances, and com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_samples_per_remote_writer.

This constant is an extension to the DDS standard.

◆ LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT

final SampleLostStatusKind LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT
static

◆ LOST_BY_VIRTUAL_WRITERS_LIMIT

final SampleLostStatusKind LOST_BY_VIRTUAL_WRITERS_LIMIT
static
Initial value:
= new SampleLostStatusKind(
"DDS_LOST_BY_VIRTUAL_WRITERS_LIMIT", 7)

A resource limit on the number of virtual writers from which a com.rti.dds.subscription.DataReader may read (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_virtual_writers) was reached.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

◆ LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT

final SampleLostStatusKind LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT", 8)

A resource limit on the number of remote writers per sample (com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max_remote_writers_per_sample) was reached.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

◆ LOST_BY_AVAILABILITY_WAITING_TIME

final SampleLostStatusKind LOST_BY_AVAILABILITY_WAITING_TIME
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_AVAILABILITY_WAITING_TIME", 9)

com.rti.dds.infrastructure.AvailabilityQosPolicy.max_data_availability_waiting_time expired.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.AvailabilityQosPolicy

◆ LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT

final SampleLostStatusKind LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT", 10)

A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a com.rti.dds.subscription.DataReader may store was reached. (This field is currently not used.)

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

◆ LOST_BY_OUT_OF_MEMORY

final SampleLostStatusKind LOST_BY_OUT_OF_MEMORY
static
Initial value:
= new SampleLostStatusKind(
"LOST_BY_OUT_OF_MEMORY", 11)

A sample was lost because there was not enough memory to store the sample.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

◆ LOST_BY_UNKNOWN_INSTANCE

final SampleLostStatusKind LOST_BY_UNKNOWN_INSTANCE
static
Initial value:
=
new SampleLostStatusKind("LOST_BY_UNKNOWN_INSTANCE", 12)

A received sample was lost because it doesn't contain enough information for the reader to know what instance it is associated with.

This constant is an extension to the DDS standard.

◆ LOST_BY_DESERIALIZATION_FAILURE

final SampleLostStatusKind LOST_BY_DESERIALIZATION_FAILURE
static
Initial value:
=
new SampleLostStatusKind("LOST_BY_DESERIALIZATION_FAILURE", 13)

A received sample was lost because it could not be deserialized.

This constant is an extension to the DDS standard.

◆ LOST_BY_DECODE_FAILURE

final SampleLostStatusKind LOST_BY_DECODE_FAILURE
static
Initial value:
=
new SampleLostStatusKind("LOST_BY_DECODE_FAILURE", 14)

When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A received sample was lost because it could not be decoded. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, the sample will be rejected, not lost, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_DECODE_FAILURE.

This constant is an extension to the DDS standard.

◆ LOST_BY_SAMPLES_PER_INSTANCE_LIMIT

final SampleLostStatusKind LOST_BY_SAMPLES_PER_INSTANCE_LIMIT
static
Initial value:
=
new SampleLostStatusKind("LOST_BY_SAMPLES_PER_INSTANCE_LIMIT", 15)

When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A resource limit on the number of samples per instance (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance) was reached. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, reaching com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples_per_instance will trigger a rejection, not a loss, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.ResourceLimitsQosPolicy

◆ LOST_BY_SAMPLES_LIMIT

final SampleLostStatusKind LOST_BY_SAMPLES_LIMIT
static
Initial value:
=
new SampleLostStatusKind("LOST_BY_SAMPLES_LIMIT", 16)

When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.BEST_EFFORT_RELIABILITY_QOS: A resource limit on the number of samples (com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples) was reached. When using com.rti.dds.infrastructure.ReliabilityQosPolicyKind.RELIABLE_RELIABILITY_QOS, reaching com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max_samples will trigger a rejection, not a loss, with reason com.rti.dds.subscription.SampleRejectedStatusKind.REJECTED_BY_SAMPLES_LIMIT.

This constant is an extension to the DDS standard.

See also
com.rti.dds.infrastructure.ResourceLimitsQosPolicy