RTI Connext Modern C++ API Version 7.1.0
|
<<extension>> The properties of a thread of execution. More...
#include <rti/core/ThreadSettings.hpp>
Public Member Functions | |
ThreadSettings () | |
Creates the default thread settings. More... | |
ThreadSettings (ThreadSettingsKindMask the_mask, int32_t the_priority, int32_t the_stack_size, dds::core::vector< int32_t > the_cpu_list, ThreadSettingsCpuRotationKind::type the_cpu_rotation) | |
Creates an instance with all the specified parameters. More... | |
ThreadSettingsKindMask | mask () const |
Getter (see setter with the same name) More... | |
ThreadSettings & | mask (ThreadSettingsKindMask the_mask) |
Describes the type of thread. More... | |
int32_t | priority () const |
Getter (see setter with the same name) More... | |
ThreadSettings & | priority (int32_t the_priority) |
Thread priority. More... | |
int32_t | stack_size () const |
Getter (see setter with the same name) More... | |
ThreadSettings & | stack_size (int32_t the_stack_size) |
The thread stack-size. More... | |
dds::core::vector< int32_t > | cpu_list () const |
Getter (see setter with the same name) More... | |
ThreadSettings & | cpu_list (const dds::core::vector< int32_t > &the_cpu_list) |
The list of processors on which the thread(s) may run. More... | |
ThreadSettingsCpuRotationKind | cpu_rotation () const |
Getter (see setter with the same name) More... | |
ThreadSettings & | cpu_rotation (ThreadSettingsCpuRotationKind the_cpu_rotation) |
Determines how processor affinity is applied to multiple threads. More... | |
<<extension>> The properties of a thread of execution.
Consult Platform Notes for additional platform specific details.
|
inline |
Creates the default thread settings.
rti::core::ThreadSettings::ThreadSettings | ( | ThreadSettingsKindMask | the_mask, |
int32_t | the_priority, | ||
int32_t | the_stack_size, | ||
dds::core::vector< int32_t > | the_cpu_list, | ||
ThreadSettingsCpuRotationKind::type | the_cpu_rotation | ||
) |
Creates an instance with all the specified parameters.
ThreadSettingsKindMask rti::core::ThreadSettings::mask | ( | ) | const |
Getter (see setter with the same name)
ThreadSettings & rti::core::ThreadSettings::mask | ( | ThreadSettingsKindMask | the_mask | ) |
Describes the type of thread.
The meaning of each bit of the mask are defined by rti::core::ThreadSettingsKindMask.
[default] 0, use default options of the OS
int32_t rti::core::ThreadSettings::priority | ( | ) | const |
Getter (see setter with the same name)
ThreadSettings & rti::core::ThreadSettings::priority | ( | int32_t | the_priority | ) |
Thread priority.
[range] Platform-dependent - Consult Platform Notes for additional details.
int32_t rti::core::ThreadSettings::stack_size | ( | ) | const |
Getter (see setter with the same name)
ThreadSettings & rti::core::ThreadSettings::stack_size | ( | int32_t | the_stack_size | ) |
The thread stack-size.
[range] Platform-dependent. Consult Platform Notes for additional details.
dds::core::vector< int32_t > rti::core::ThreadSettings::cpu_list | ( | ) | const |
Getter (see setter with the same name)
ThreadSettings & rti::core::ThreadSettings::cpu_list | ( | const dds::core::vector< int32_t > & | the_cpu_list | ) |
The list of processors on which the thread(s) may run.
A sequence of integers that represent the set of processors on which the thread(s) controlled by this QoS may run. An empty sequence (the default) means the middleware wlll make no CPU affinity adjustments.
Note: This feature is currently only supported on a subset of architectures (see the Platform Notes). The API may change as more architectures are added in future releases.
This value is only relevant to the rti::core::policy::ReceiverPool. It is ignored within other QoS policies that include rti::core::ThreadSettings.
[default] Empty sequence
ThreadSettingsCpuRotationKind rti::core::ThreadSettings::cpu_rotation | ( | ) | const |
Getter (see setter with the same name)
ThreadSettings & rti::core::ThreadSettings::cpu_rotation | ( | ThreadSettingsCpuRotationKind | the_cpu_rotation | ) |
Determines how processor affinity is applied to multiple threads.
This value is only relevant to the rti::core::policy::ReceiverPool. It is ignored within other QoS policies that include rti::core::ThreadSettings.
Note: This feature is currently only supported on a subset of architectures (see the Platform Notes). The API may change as more architectures are added in future releases.