|
RTI Connext Modern C++ API
Version 6.1.2
|
<<extension>> Configures threads that RTI Connext uses to receive and process data from the transport modules (such as UDP) More...
#include <rti/core/policy/CorePolicy.hpp>
Public Member Functions | |
| ReceiverPool () | |
| Creates the default policy. More... | |
| ReceiverPool (const rti::core::ThreadSettings &the_thread, int32_t the_buffer_size, int32_t the_buffer_alignment) | |
| Creates an instance with the thread settings, buffer size and buffer alignment configuration. More... | |
| ReceiverPool & | thread (const rti::core::ThreadSettings &the_thread) |
| Configures the receiver pool thread(s) More... | |
| const rti::core::ThreadSettings & | thread () const |
| Getter (see setter with the same name) More... | |
| rti::core::ThreadSettings & | thread () |
| Getter (see setter with the same name) More... | |
| ReceiverPool & | buffer_size (int32_t the_buffer_size) |
| Sets the length of the buffer used to store the incoming raw data. More... | |
| int32_t | buffer_size () const |
| Getter (see setter with the same name) More... | |
| ReceiverPool & | buffer_alignment (int32_t the_buffer_alignment) |
| Sets the receive buffer alignment. More... | |
| int32_t | buffer_alignment () const |
| Getter (see setter with the same name) More... | |
Static Public Attributes | |
| static OMG_DDS_API_CLASS_VARIABLE const int32_t | LENGTH_AUTO |
| Indicates that the length will be automatically resolved. More... | |
<<extension>> Configures threads that RTI Connext uses to receive and process data from the transport modules (such as UDP)
This QoS policy is an extension to the DDS standard.
This QoS policy sets the thread properties such as priority level and stack size for the threads used by the middleware to receive and process data from transports.
RTI uses a separate receive thread per port per transport plug-in. To force RTI Connext to use a separate thread to process the data for a dds::sub::DataReader, set a unique port for the rti::core::policy::TransportUnicast or rti::core::policy::TransportMulticast for the dds::sub::DataReader.
This QoS policy also sets the size of the buffer used to store packets received from a transport. This buffer size will limit the largest single packet of data that a dds::domain::DomainParticipant will accept from a transport. Users will often set this size to the largest packet that any of the transports used by their application will deliver. For many applications, the value 65,536 (64 K) is a good choice; this value is the largest packet that can be sent/received via UDP.
|
inline |
Creates the default policy.
| rti::core::policy::ReceiverPool::ReceiverPool | ( | const rti::core::ThreadSettings & | the_thread, |
| int32_t | the_buffer_size, | ||
| int32_t | the_buffer_alignment | ||
| ) |
Creates an instance with the thread settings, buffer size and buffer alignment configuration.
See individual setters.
| ReceiverPool& rti::core::policy::ReceiverPool::thread | ( | const rti::core::ThreadSettings & | the_thread | ) |
Configures the receiver pool thread(s)
There is at least one receive thread, possibly more.
[default] priority above normal.
The actual value depends on your architecture:
For Windows: 2
For Linux: OS default priority
For a complete list of platform specific values, please refer to Platform Notes.
[default] The actual value depends on your architecture:
For Windows: OS default stack size
For Linux: OS default stack size
For a complete list of platform specific values, please refer to Platform Notes.
[default] mask rti::core::ThreadSettingsKindMask::floating_point() | rti::core::ThreadSettingsKindMask::stdio()
| const rti::core::ThreadSettings& rti::core::policy::ReceiverPool::thread | ( | ) | const |
Getter (see setter with the same name)
| rti::core::ThreadSettings& rti::core::policy::ReceiverPool::thread | ( | ) |
Getter (see setter with the same name)
| ReceiverPool& rti::core::policy::ReceiverPool::buffer_size | ( | int32_t | the_buffer_size | ) |
Sets the length of the buffer used to store the incoming raw data.
The receive buffer is used by the receive thread to store the raw data that arrives over the transports in non-zero-copy transports.
Zero-copy transports do not copy their data into the buffer provided by the receive thread. Instead, they provide the receive thread data in buffers allocated by the transports themselves. Only the shared memory built-in transport (SHMEM) supports zero-copy.
buffer_size must always be at least as large as the maximum NDDS_Transport_Property_t::message_size_max across all of the transports being used that are not doing zero-copy.
By default (LENGTH_AUTO): the size is equal to the maximum NDDS_Transport_Property_t::message_size_max across all of the non-zero-copy transports.
You may want the value to be greater than the default if you try to limit the largest data packet that can be sent through the transport(s) in one application, but you still want to receive data from other applications that have not made the same change.
For example, to avoid IP fragmentation, you may want to set NDDS_Transport_Property_t::message_size_max for IP-based transports to a small value, such as 1400 bytes. However, you may not be able to apply this change to all the applications at the same time. To receive data from these other applications the buffer_size should be equal to the original NDDS_Transport_Property_t::message_size_max.
[default] LENGTH_AUTO
[range] [1, 1 GB] or LENGTH_AUTO
| int32_t rti::core::policy::ReceiverPool::buffer_size | ( | ) | const |
Getter (see setter with the same name)
| ReceiverPool& rti::core::policy::ReceiverPool::buffer_alignment | ( | int32_t | the_buffer_alignment | ) |
Sets the receive buffer alignment.
The receive buffer is used by the receive thread to store the raw data that arrives over the transports in non-zero-copy transports.
Zero-copy transports do not copy their data into the buffer provided by the receive thread. Instead, they provide the receive thread data in buffers allocated by the transports themselves. Only the shared memory built-in transport (SHMEM) supports zero-copy.
buffer_size must always be at least as large as the maximum NDDS_Transport_Property_t::message_size_max across all of the transports being used that are not doing zero-copy.
By default (LENGTH_AUTO): the size is equal to the maximum NDDS_Transport_Property_t::message_size_max across all of the non-zero-copy transports.
You may want the value to be greater than the default if you try to limit the largest data packet that can be sent through the transport(s) in one application, but you still want to receive data from other applications that have not made the same change.
For example, to avoid IP fragmentation, you may want to set NDDS_Transport_Property_t::message_size_max for IP-based transports to a small value, such as 1400 bytes. However, you may not be able to apply this change to all the applications at the same time. To receive data from these other applications the buffer_size should be equal to the original NDDS_Transport_Property_t::message_size_max.
[default] LENGTH_AUTO
[range] [1, 1 GB] or LENGTH_AUTO
| int32_t rti::core::policy::ReceiverPool::buffer_alignment | ( | ) | const |
Getter (see setter with the same name)
|
static |
Indicates that the length will be automatically resolved.