Specifies the resources that the Service can consume in order to meet the requested QoS. More...

Inheritance diagram for org.omg.dds.core.policy.ResourceLimits:

Collaboration diagram for org.omg.dds.core.policy.ResourceLimits:

Public Member Functions
ServiceEnvironment	getEnvironment ()

int	getMaxInstances ()

int	getMaxSamples ()

int	getMaxSamplesPerInstance ()

ResourceLimits	withMaxInstances (int maxInstances)
	Copy this policy and override the value of the property. More...

ResourceLimits	withMaxSamples (int maxSamples)
	Copy this policy and override the value of the property. More...

ResourceLimits	withMaxSamplesPerInstance (int maxSamplesPerInstance)
	Copy this policy and override the value of the property. More...

Static Public Attributes
static final int	LENGTH_UNLIMITED = -1

Detailed Description

Specifies the resources that the Service can consume in order to meet the requested QoS.

Concerns: org.omg.dds.topic.Topic, org.omg.dds.sub.DataReader, org.omg.dds.pub.DataWriter

RxO: No

Changeable: No

This policy controls the resources that the Service can use in order to meet the requirements imposed by the application and other QoS settings.

If the DataWriter objects are communicating samples faster than they are ultimately taken by the DataReader objects, the middleware will eventually hit against some of the QoS-imposed resource limits. Note that this may occur when just a single DataReader cannot keep up with its corresponding DataWriter. The behavior in this case depends on the setting for the org.omg.dds.core.policy.Reliability. If reliability is Reliability.Kind#BEST_EFFORT, then the Service is allowed to drop samples. If the reliability is Reliability.Kind#RELIABLE, the Service will block the DataWriter or discard the sample at the DataReader in order not to lose existing samples (so that the sample can be resent at a later time).

The constant LENGTH_UNLIMITED may be used to indicate the absence of a particular limit. For example setting maxSamplesPerInstance to LENGH_UNLIMITED will cause the middleware to not enforce this particular limit.

The setting of RESOURCE_LIMITS maxSamples must be consistent with the maxSamplesPerInstance. For these two values to be consistent they must verify that "max_samples >= max_samples_per_instance."

The setting of RESOURCE_LIMITS maxSamplesPerInstance must be consistent with the HISTORY depth. For these two QoS to be consistent, they must verify that "depth <= maxSamplesPerInstance."

An attempt to set this policy to inconsistent values when an entity is created or via a setQos operation will cause the operation to fail.

See also: History; Reliability

Definition at line 68 of file ResourceLimits.java.

Member Function Documentation

◆ 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.

◆ getMaxInstances()

int org.omg.dds.core.policy.ResourceLimits.getMaxInstances ( )

Returns: the maxInstances

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

◆ getMaxSamples()

int org.omg.dds.core.policy.ResourceLimits.getMaxSamples ( )

Returns: the maxSamples

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

◆ getMaxSamplesPerInstance()

int org.omg.dds.core.policy.ResourceLimits.getMaxSamplesPerInstance ( )

Returns: the maxSamplesPerInstance

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

◆ withMaxInstances()

ResourceLimits org.omg.dds.core.policy.ResourceLimits.withMaxInstances ( int maxInstances )

Copy this policy and override the value of the property.

Parameters

maxInstances Specifies the maximum number of instances for any single DataWriter (or DataReader). By default, unlimited.

Returns: a new ResourceLimits policy

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

◆ withMaxSamples()

ResourceLimits org.omg.dds.core.policy.ResourceLimits.withMaxSamples ( int maxSamples )

Copy this policy and override the value of the property.

Parameters

maxSamples Specifies the maximum number of data samples for all instances for any single DataWriter (or DataReader). By default, unlimited.

Returns: a new ResourceLimits policy

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

◆ withMaxSamplesPerInstance()

ResourceLimits org.omg.dds.core.policy.ResourceLimits.withMaxSamplesPerInstance ( int maxSamplesPerInstance )

Copy this policy and override the value of the property.

Parameters

maxSamplesPerInstance Specifies the maximum number of samples of any single instance for any single DataWriter (or DataReader). By default, unlimited.

Returns: a new ResourceLimits policy

Implemented in org.opensplice.dds.core.policy.ResourceLimitsImpl.

Member Data Documentation

◆ LENGTH_UNLIMITED

final int org.omg.dds.core.policy.ResourceLimits.LENGTH_UNLIMITED = -1

static

Definition at line 71 of file ResourceLimits.java.

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

java5/common/java/code/org/omg/dds/core/policy/ResourceLimits.java

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ getEnvironment()

◆ getMaxInstances()

◆ getMaxSamples()

◆ getMaxSamplesPerInstance()

◆ withMaxInstances()

◆ withMaxSamples()

◆ withMaxSamplesPerInstance()

Member Data Documentation

◆ LENGTH_UNLIMITED