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"

Data Structures
struct	OSAPI_SystemUUID
	UUID definition. More...
struct	OSAPI_SystemI
struct	OSAPI_SystemListener
struct	OSAPI_SystemProperty

Typedefs
typedef RTI_BOOL(*	OSAPI_System_start_timer_T )(OSAPI_Timer_T self, OSAPI_TimerTickHandlerFunction tick_handler)
typedef RTI_BOOL(*	OSAPI_System_stop_timer_T )(OSAPI_Timer_T self)
typedef RTI_INT32(*	OSAPI_System_get_timer_resolution_T )(void)
typedef RTI_BOOL(*	OSAPI_System_get_time_T )(OSAPI_NtpTime *now)
typedef RTI_BOOL(*	OSAPI_System_initialize_T )(void)
typedef RTI_BOOL(*	OSAPI_System_finalize_T )(void)
typedef RTI_BOOL(*	OSAPI_System_get_hostname_T )(char *const hostname)
typedef RTI_BOOL(*	OSAPI_System_on_system_initialize_T )(void *listener_data, struct OSAPI_System *system)

Functions
RTI_BOOL	OSAPI_System_set_interface (struct OSAPI_SystemI *intf)
	Set system interface.
RTI_BOOL	OSAPI_System_get_interface (struct OSAPI_SystemI *intf)
	Get the current system interface.
RTI_BOOL	OSAPI_System_set_listener (struct OSAPI_SystemListener *listener)
	Install a system listeners.
RTI_BOOL	OSAPI_System_get_listener (struct OSAPI_SystemListener *listener)
	Get current system listeners.
RTI_BOOL	OSAPI_System_generate_uuid (struct OSAPI_SystemUUID *uuid_out)
	Generate a unique universal identifier (UUID)
RTI_BOOL	OSAPI_System_get_time (OSAPI_NtpTime *now)
	Get the current system time.
RTI_INT32	OSAPI_System_get_timer_resolution (void)
	Get the resolution of the clock driving the timer in nano seconds.
RTI_BOOL	OSAPI_System_start_timer (OSAPI_Timer_T self, OSAPI_TimerTickHandlerFunction tick_handler)
	Start the timer.
RTI_BOOL	OSAPI_System_stop_timer (OSAPI_Timer_T self)
	Stop the timer.
RTI_BOOL	OSAPI_System_initialize (void)
	Initialize the system.
RTI_BOOL	OSAPI_System_finalize (void)
	Finalize the system.
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_get_hostname (char *const hostname)
	Get the hostname.
RTI_BOOL	OSAPI_System_get_ticktime (RTI_INT32 *sec, RTI_UINT32 *nanosec)
	Get current tick time.
OSAPI_Semaphore_T *	OSAPI_System_get_thread_semaphore (void)
	Get a semaphore to suspend a thread.
OSAPI_Semaphore_T *	OSAPI_System_get_user_thread_semaphore (void)
	Get a semaphore to suspend a user thread.
void	OSAPI_System_return_thread_semaphore (OSAPI_Semaphore_T *sem)
	Return a semaphore acquired with OSAPI_System_get_thread_semaphore.
void	OSAPI_System_return_user_thread_semaphore (OSAPI_Semaphore_T *sem)
	Return a user semaphore acquired with OSAPI_System_get_thread_semaphore.

---

Detailed Description

System API definition.