osapi_system.h File Reference

System API definition. More...

#include "osapi/osapi_dll.h"
#include "osapi/osapi_time.h"
#include "osapi/osapi_timer.h"
#include "osapi/osapi_semaphore.h"
#include "osapi/osapi_thread.h"
#include "osapi/osapi_types.h"
#include "osapi/osapi_log.h"
#include "osapi/osapi_string.h"

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.

Typedefs
typedef RTI_BOOL(*	OSAPI_System_start_timer_T )(OSAPI_Timer_T self, OSAPI_TimerTickHandlerFunction tick_handler)
	Start a OSAPI timer.
typedef RTI_INT32(*	OSAPI_System_get_timer_resolution_T )(void)
	Get the resolution of the clock driving the timer in nano seconds.
typedef RTI_BOOL(*	OSAPI_System_get_time_T )(OSAPI_NtpTime *now)
	Get the current system time.
typedef RTI_BOOL(*	OSAPI_System_initialize_T )(void)
	Initialize the system.
typedef RTI_BOOL(*	OSAPI_System_get_hostname_T )(char *const hostname)
	Get the hostname.
typedef RTI_BOOL(*	OSAPI_System_generate_uuid_T )(struct OSAPI_SystemUUID *uuid_out)
	Generate a unique universal identifier (UUID).
typedef RTI_BOOL(*	OSAPI_System_get_ticktime_T )(RTI_INT32 *sec, RTI_UINT32 *nanosec)
	Get current tick time.
typedef struct OSAPI_SystemI	OSAPI_SystemI
	<<cert>> System API.

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.
RTI_BOOL	OSAPI_System_clock_tick (RTI_UINT32 ticks)
	Advance the internal RTI Connext DDS Micro timers with the number specified clock ticks.
RTI_BOOL	OSAPI_System_clock_tick_from_time (void)
	Advance the internal RTI Connext DDS Micro timers using the OSAPI_SystemI::get_time API.

---

Detailed Description

System API definition.