RTI Connext Micro C API Version 4.2.0
Loading...
Searching...
No Matches
OSAPI_SystemProperty Struct Reference

<<cert>> The System Properties. More...

#include <osapi_system.h>

Data Fields

struct OSAPI_TimerProperty timer_property
 Timer properties.
 
char hostname [OSAPI_SYSTEM_MAX_HOSTNAME]
 The hostname for the node.
 
RTI_INT32 max_user_blocking_threads
 The maximum number of threads which can block at the same time.
 
RTI_INT32 max_timers
 The maximum number timers the OS platform support library is required to support.
 

Detailed Description

<<cert>> The System Properties.

System properties

Field Documentation

◆ timer_property

struct OSAPI_TimerProperty OSAPI_SystemProperty::timer_property

Timer properties.

The timer properties control the time thread running the internal RTI Connext DDS Micro timer tick. Note that each port of RTI Connext DDS Micro may choose to implement the timer tick differently. Please refer to platform specifc information for details.

◆ hostname

char OSAPI_SystemProperty::hostname[OSAPI_SYSTEM_MAX_HOSTNAME]

The hostname for the node.

RTI Connext DDS Micro uses this name when it announces itself on the network. This name is used by other RTI products. The hostname must not exceed OSAPI_SYSTEM_MAX_HOSTNAME, including the \0 character.

◆ max_user_blocking_threads

RTI_INT32 OSAPI_SystemProperty::max_user_blocking_threads

The maximum number of threads which can block at the same time.

RTI Connext DDS Micro supports blocking operations, such as DDS_KEEP_ALL_HISTORY_QOS, and may block the user thread in certain conditions, e.g. if out of resources. The maximum number of threads that RTI Connext DDS Micro can block at the same time is controlled by this property.

If a blocking operation is unable to acquire a blocking resource, the operation will return with DDS_RETCODE_OUT_OF_RESOURCES.

Note that receive threads created by a transport and threads calling DDS APIs are both considered user threads.

[default] 32

[range] [1, INT_MAX]

◆ max_timers

RTI_INT32 OSAPI_SystemProperty::max_timers

The maximum number timers the OS platform support library is required to support.

RTI Connext DDS Micro implements its own software timers to keep track of Qos polcicies such as DDS_DeadlineQosPolicy. These software timers are driven by the underlying platform RTI Connext DDS Micro is executing on. This property configures the maximum number of timers that the OS is required to support.

RTI Connext DDS Micro allocated uses these timers as follows:

The default value supports 8 DomainParticipants without Zero Copy v2 API enabled and 4 DomainParticipants with netio_zcopy enabled.

[default] 8

[range] [1, INT_MAX]