OSAPI System API

Abstract System API. More...

Data Structures
struct	OSAPI_SystemI
	<<cert>> System API. More...
struct	OSAPI_SystemProperty
	<<cert>> The System Properties. More...

Macros
#define	OSAPI_SYSTEM_MAX_HOSTNAME   (64)
	Maximum hostname length.
#define	OSAPI_SystemI_INITIALIZER
	<<cert>> Initializer for OSAPI_SystemI.

Functions
RTI_BOOL	OSAPI_System_set_interface (struct OSAPI_SystemI *intf)
	Set the system interface.
RTI_BOOL	OSAPI_System_get_property (struct OSAPI_SystemProperty *property)
	Get the system properties.
RTI_BOOL	OSAPI_System_set_property (struct OSAPI_SystemProperty *property)
	Set the system properties.
void	OSAPI_System_get_native_interface (struct OSAPI_SystemI *intf)
	Get the native system interface.

---

Detailed Description

Abstract System API.

The System is defined as the physical or virtual execution environment and implements functions that are not necessarily provided by the operating system. For example, a custom embedded board may include a special real-time clock which is synchronized via GPS, but is not available via a regular OS system call.

The following functions are not thread-safe:

• OSAPI_System_set_interface
• OSAPI_System_get_property
• OSAPI_System_set_property
• OSAPI_System_get_native_interface

---

Macro Definition Documentation

#define OSAPI_SYSTEM_MAX_HOSTNAME   (64)

Maximum hostname length.

#define OSAPI_SystemI_INITIALIZER

Value:

{\
    NULL,\
    NULL,\
    NULL,\
    NULL,\
    NULL,\
    NULL,\
    NULL,\
    NULL,\
    NULL\
}

<<cert>> Initializer for OSAPI_SystemI.

---

Function Documentation

RTI_BOOL OSAPI_System_set_interface

(

struct OSAPI_SystemI *

intf

)

Set the system interface.

This function sets the system interface, overriding the current system interface.

Parameters:

[in]

intf

If intf is NULL, all interfaces are set to NULL.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

MT Safety:

This operation is not thread safe.

API Restriction:

This function may be called before DDS_DomainParticipantFactory_get_instance.

RTI_BOOL OSAPI_System_get_property

(

struct OSAPI_SystemProperty *

property

)

Get the system properties.

Copy the current system properties to the argument.

Parameters:

[out]

property

The current system properties on success.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

MT Safety:

This operation is not thread safe.

API Restriction:

This function may be called before DDS_DomainParticipantFactory_get_instance.

RTI_BOOL OSAPI_System_set_property

(

struct OSAPI_SystemProperty *

property

)

Set the system properties.

The system properties can be set until the system has been initialized by calling OSAPI_System_initialize(). Note that OSAPI_System_initialize() is called by DDS_DomainParticipantFactory_get_instance().

Parameters:

[in]

property

The system properties to set.

Returns:

RTI_TRUE on success, RTI_FALSE on failure.

MT Safety:

This operation is not thread safe.

API Restriction:

This function may be called before DDS_DomainParticipantFactory_get_instance.

void OSAPI_System_get_native_interface

(

struct OSAPI_SystemI *

intf

)

Get the native system interface.

This function returns the native system interface.

Parameters:

[out]

intf

Cannot be NULL.

MT Safety:

This operation is not thread safe.

API Restriction:

This function may be called before DDS_DomainParticipantFactory_get_instance.