RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
dds::core::policy::TransportPriority Class Reference

Allows applications to take advantage of transports capable of sending messages with different priorities. More...

#include <dds/core/policy/CorePolicy.hpp>

Public Member Functions

 TransportPriority ()
 Creates a policy with priority 0.
 
 TransportPriority (int32_t priority)
 Creates a policy with the specified priority.
 
TransportPriorityvalue (int32_t priority)
 Sets the priority.
 
int32_t value () const
 Getter (see setter with the same name)
 

Detailed Description

Allows applications to take advantage of transports capable of sending messages with different priorities.

The Transport Priority QoS policy is optional and only supported on certain OSs and transports. It allows you to specify on a per-DataWriter or DataReader basis that the data sent by that endpoint is of a different priority.

The DDS specification does not indicate how a DDS implementation should treat data of different priorities. It is often difficult or impossible for DDS implementations to treat data of higher priority differently than data of lower priority, especially when data is being sent (delivered to a physical transport) directly by the thread that called dds::pub::DataWriter::write(). Also, many physical network transports themselves do not have a end-user controllable level of data packet priority.

Entity:
dds::pub::DataWriter, dds::sub::DataReader, dds::topic::Topic
Properties:
RxO = N/A
Changeable = NO

Usage

In RTI Connext, for the UDPv4Transport, the value set in the Transport Priority QoS policy is used in a setsockopt call to set the TOS (type of service) bits of the IPv4 header for datagrams sent by a dds::pub::DataWriter or dds::sub::DataReader. It is platform-dependent how and whether the setsockopt has an effect. On some platforms, such as Windows and Linux, external permissions must be given to the user application in order to set the TOS bits.

When using the UDPv6 Transport, the value set in the Transport Priority QoS policy is mapped to the Traffic Class bits of the IPv6 header. Please see the Platform Notes for details whether this mapping is supported on your plaform.

It is incorrect to assume that using the Transport Priority QoS policy will have any effect at all on the end-to-end delivery of data from a dds::pub::DataWriter and a dds::sub::DataReader. All network elements, including switches and routers must have the capability and be enabled to actually use the TOS bits to treat higher priority packets differently. Thus the ability to use the Transport Priority QoS policy must be designed and configured at a system level; just turning it on in an application may have no effect at all.

Constructor & Destructor Documentation

dds::core::policy::TransportPriority::TransportPriority ( )
inline

Creates a policy with priority 0.

dds::core::policy::TransportPriority::TransportPriority ( int32_t  priority)
inlineexplicit

Creates a policy with the specified priority.

Member Function Documentation

TransportPriority& dds::core::policy::TransportPriority::value ( int32_t  priority)
inline

Sets the priority.

You may choose any value within the range of a 32-bit signed integer; higher values indicate higher priority. However, any further interpretation of this policy is specific to a particular transport and a particular DDS implementation. For example, a particular transport is permitted to treat a range of priority values as equivalent to one another.

[default] 0

int32_t dds::core::policy::TransportPriority::value ( ) const
inline

Getter (see setter with the same name)


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc