org.omg.dds.core.status.SampleRejectedStatus Class Reference

A (received) sample has been rejected. More...

Inheritance diagram for org.omg.dds.core.status.SampleRejectedStatus:

Collaboration diagram for org.omg.dds.core.status.SampleRejectedStatus:

Classes
enum	Kind

Public Member Functions
ServiceEnvironment	getEnvironment ()
abstract InstanceHandle	getLastInstanceHandle ()
	Handle to the instance being updated by the last sample that was rejected. More...
abstract Kind	getLastReason ()
	Reason for rejecting the last sample rejected. More...
abstract int	getTotalCount ()
	Total cumulative count of samples rejected by the org.omg.dds.sub.DataReader. More...
abstract int	getTotalCountChange ()
	The incremental number of samples rejected since the last time the listener was called or the status was read. More...

Static Public Member Functions
static Set< Class<? extends Status > >	allStatuses (ServiceEnvironment env)
static Set< Class<? extends Status > >	noStatuses (ServiceEnvironment env)

Detailed Description

A (received) sample has been rejected.

When the ResourceLimits Qos is active a SampleRejectStatus can occur when the History determined by History QoS of the DataReader is full.

See also

org.omg.dds.core.event.SampleRejectedEvent

Definition at line 35 of file SampleRejectedStatus.java.

Member Function Documentation

allStatuses()

static Set<Class<? extends Status> > org.omg.dds.core.status.Status.allStatuses ( ServiceEnvironment  env )

staticinherited

Parameters

env	Identifies the Service instance to which the object will belong.

Definition at line 59 of file Status.java.

getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )

inherited

Returns

the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

getLastInstanceHandle()

abstract InstanceHandle org.omg.dds.core.status.SampleRejectedStatus.getLastInstanceHandle ( )

abstract

Handle to the instance being updated by the last sample that was rejected.

getLastReason()

abstract Kind org.omg.dds.core.status.SampleRejectedStatus.getLastReason ( )

abstract

Reason for rejecting the last sample rejected.

If no samples have been rejected, the reason is the special value Kind#NOT_REJECTED. The following values are valid reasons:

• NOT_REJECTED - no sample has been rejected yet.
• REJECTED_BY_INSTANCES_LIMIT - the sample was rejected because it would exceed the maximum number of instances set by the ResourceLimitsQosPolicy.
• REJECTED_BY_SAMPLES_LIMIT - the sample was rejected because it would exceed the maximum number of samples set by the ResourceLimitsQosPolicy.
• REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT - the sample was rejected because it would exceed the maximum number of samples per instance set by the ResourceLimitsQosPolicy.

getTotalCount()

abstract int org.omg.dds.core.status.SampleRejectedStatus.getTotalCount ( )

abstract

Total cumulative count of samples rejected by the org.omg.dds.sub.DataReader.

getTotalCountChange()

abstract int org.omg.dds.core.status.SampleRejectedStatus.getTotalCountChange ( )

abstract

The incremental number of samples rejected since the last time the listener was called or the status was read.

noStatuses()

static Set<Class<? extends Status> > org.omg.dds.core.status.Status.noStatuses ( ServiceEnvironment  env )

staticinherited

Parameters

env	Identifies the Service instance to which the object will belong.

Definition at line 70 of file Status.java.

---

The documentation for this class was generated from the following file:

• java5/common/java/code/org/omg/dds/core/status/SampleRejectedStatus.java