OpenSplice ISO C++ 2 DCPS  v7.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::core::policy::LatencyBudget Class Reference

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::LatencyBudget:
Inheritance graph

Public Member Functions

 LatencyBudget (const dds::core::Duration &duration=dds::core::Duration::zero())
 
 LatencyBudget (const LatencyBudget &other)
 
LatencyBudgetduration (const dds::core::Duration &duration)
 
const dds::core::Duration duration () const
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 

Detailed Description

Specifies the maximum acceptable additional delay to the typical transport delay from the time the data is written until the data is delivered at the DataReader and the application is notified of this fact.

Attributes

Value Meaning Concerns RxO Changeable
A duration:
duration
Specifies the maximum acceptable delay from the time the data is written until the data is inserted in the receiver's application-cache and the receiving application is notified of the fact. This policy is a hint to the Service, not something that must be monitored or enforced. The Service is not required to track or alert the user of any violation. The default value of the duration is zero indicating that the delay should be minimised. Topic, DataReader, DataWriter Yes Yes

This policy provides a means for the application to indicate to the middleware the “urgency” of the data-communication. By having a non-zero duration the Service can optimise its internal operation.

This policy is considered a hint. There is no specified mechanism as to how the service should take advantage of this hint.

The value offered is considered compatible with the value requested if and only if the inequality “offered duration <= requested duration” evaluates to ‘TRUE.’

Definition at line 449 of file CorePolicy.hpp.

Constructor & Destructor Documentation

◆ LatencyBudget() [1/2]

dds::core::policy::LatencyBudget::LatencyBudget ( const dds::core::Duration duration = dds::core::Duration::zero())
explicit

Creates a LatencyBudget QoS instance

Parameters
durationduration

Definition at line 379 of file CorePolicyImpl.hpp.

◆ LatencyBudget() [2/2]

dds::core::policy::LatencyBudget::LatencyBudget ( const LatencyBudget other)

Copies a LatencyBudget QoS instance

Parameters
otherthe LatencyBudget QoS instance to copy

Definition at line 382 of file CorePolicyImpl.hpp.

Member Function Documentation

◆ duration() [1/2]

LatencyBudget & dds::core::policy::LatencyBudget::duration ( const dds::core::Duration duration)

Sets the duration

Parameters
durationduration

Definition at line 385 of file CorePolicyImpl.hpp.

◆ duration() [2/2]

const dds::core::Duration dds::core::policy::LatencyBudget::duration ( ) const

Gets the duration

Returns
duration

Definition at line 392 of file CorePolicyImpl.hpp.

◆ operator!=()

template<typename D >
bool dds::core::Value< D >::operator!= ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if not equal

Definition at line 99 of file Value.hpp.

◆ operator->() [1/2]

template<typename D >
D * dds::core::Value< D >::operator-> ( )
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 111 of file Value.hpp.

◆ operator->() [2/2]

template<typename D >
const D * dds::core::Value< D >::operator-> ( ) const
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 105 of file Value.hpp.

◆ operator==()

template<typename D >
bool dds::core::Value< D >::operator== ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if equal

Definition at line 93 of file Value.hpp.


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