ERC CISST - cisst software

---

OS Abstraction

---

Detailed Description

Note:

All the classes and global functions of cisstOSAbstraction start with the prefix osa. To use cisstOSAbstraction, you can either include the files one by one with:

  #include <cisstOSAbstraction/osaXyz.h>

or include all the files with:

  #include <cisstOSAbstraction.h>

Files

• file osaMutex.h

  Declaration of osaMutex.
  

• file osaSocket.h

  Declaration of osaSocket.
  

• file osaSocketServer.h

  Declaration of osaSocketServer.
  

• file osaThread.h

  Declaration of osaThread.
  

• file osaThreadAdapter.h

  Defines a thread adapter.
  

• file osaThreadSignal.h

  Declaration of osaThreadSignal.
  

Classes

• class osaDynamicLoader

  Dynamically load a shared library file. More...
  

• class osaDynamicLoaderAndFactory< BaseClass >

  Dynamically load a shared library file and find the factory methods in the file. More...
  

• class osaMutex

  Define a Mutex object. More...
  

• class osaSerialPort

  Serial port. More...
  

• class osaThread

  Define a thread object. More...
  

• struct osaCallBackBase< _objectType, _callBackMethodType, _userDataType >
• struct osaHeapCallBack< _objectType, _userDataType, _callBackReturnType, _callBackArgumentType >
• class osaThreadBuddy

  Implementation of the Thread Proxy object in an OS independent manner. More...
  

• class osaTimeServer

  Class for relative time. More...
  

Functions

• void CISST_EXPORT osaSleep (double timeInSeconds)

  Define osaSleep.
  

• CISST_EXPORT void __os_init (void)
• CISST_EXPORT void __os_exit (void)

---

Function Documentation

CISST_EXPORT void __os_exit

(

void

)

The OS dependent cleanup that is to be executed for real-time support. This is called from the destructor of TaskManager.

CISST_EXPORT void __os_init

(

void

)

The OS dependent initialization that is to be executed for real-time support. This is called from the constructor of TaskManager, which is implemented as singleton.

void CISST_EXPORT osaSleep

(

double

timeInSeconds

)

Define osaSleep.

Execute a wait or sleep. This is intended for general purpose use; no time guarantees are made on any OS. Within a thread, it is preferable to call osaThread::Sleep. The mtsTask class provides mtsTask::Sleep, which invokes osaThread::Sleep.

On some platforms, osaSleep might block the calling thread and not relinquish the processor to other threads. In particular, there are reports that calling osaSleep in RTAI may lead to stack overflows.

Parameters:

time

Time in seconds to sleep

---