dds::core::policy::TransportPriority Class Reference

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::TransportPriority:

Public Member Functions
	TransportPriority (int32_t priority=0)
	TransportPriority (const TransportPriority &other)
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const
TransportPriority &	value (int32_t priority)
int32_t	value () const

Detailed Description

This QosPolicy specifies the priority with which the Data Distribution System can handle the data produced by the DataWriter.

Attributes

Value	Meaning	Concerns	RxO	Changeable
A long: value	This policy is a hint to the infrastructure as to how to set the priority of the underlying transport used to send the data. The default value of the transport_priority is zero.	Topic, DataWriter	N/A	Yes

The purpose of this QoS is to allow the application to take advantage of transports capable of sending messages with different priorities. This policy is considered a hint. The policy depends on the ability of the underlying transports to set a priority on the messages they send. Any value within the range of a 32-bit signed integer may be chosen; higher values indicate higher priority. However, any further interpretation of this policy is specific to a particular transport and a particular implementation of the Service.It is expected that during transport configuration the application would provide a mapping between the values of the TRANSPORT_PRIORITY set on DataWriter and the values meaningful to each transport. This mapping would then be used by the infrastructure when propagating the data written by the DataWriter.

Definition at line 332 of file CorePolicy.hpp.

Constructor & Destructor Documentation

TransportPriority() [1/2]

dds::core::policy::TransportPriority::TransportPriority ( int32_t  priority = 0 )

explicit

Creates a TransportPriority QoS instance

Parameters

priority

the priority value

Definition at line 316 of file CorePolicyImpl.hpp.

TransportPriority() [2/2]

dds::core::policy::TransportPriority::TransportPriority

(

const TransportPriority &

other

)

Copies a TransportPriority QoS instance

Parameters

other

the TransportPriority QoS instance to copy

Definition at line 319 of file CorePolicyImpl.hpp.

Member Function Documentation

operator!=()

template<typename D >

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

inherited

Compare this Value with another Value

Parameters

other

Value

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

other

Value

Returns

true if equal

Definition at line 93 of file Value.hpp.

value() [1/2]

TransportPriority & dds::core::policy::TransportPriority::value

(

int32_t

priority

)

Sets the priority value

Parameters

priority

the priority value

Definition at line 322 of file CorePolicyImpl.hpp.

value() [2/2]

int32_t dds::core::policy::TransportPriority::value

(

)

const

Gets the priority value

Returns

the priority value

Definition at line 329 of file CorePolicyImpl.hpp.

---

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

• include/dcps/C++/isocpp2/dds/core/policy/CorePolicy.hpp
• include/dcps/C++/isocpp2/dds/core/policy/detail/CorePolicyImpl.hpp