<OSAPIProcess> - OSAPIProcess

The OSAPIProcess provides methods for controlling and monitoring threads and processes. More...

Functions

Macros

Function Documentation

double OSAPIGetApplicationMemoryUsed()

Returns the amount of memory used.

OSAPITASK_ID_TYPE OSAPIGetCurrentThreadId(void)

Returns the Operating System dependent Thread Id.

CDP::ProcessPriority OSAPIGetProcessPriority()

Returns the process priority or CDP::UnknownProcessPriority on failure.

See also OSAPISetProcessPriority.

int OSAPIGetThreadPolicy(OSAPITASK_HANDLE_TYPE threadHandle = 0)

Only implemented on Linux. Returns the policy of the calling thread or OSAPITASK_POLICY_INVALID on failure. Value SCHED_OTHER (0) is returned if _POSIX_THREAD_PRIORITY_SCHEDULING is not supported.

See also OSAPISetThreadPriority.

CDP::ThreadPriority OSAPIGetThreadPriority(OSAPITASK_HANDLE_TYPE threadHandle = 0)

Returns the priority of the calling thread threadHandle or CDP::UnknownThreadPriority on failure.

See also OSAPISetThreadPriority.

double OSAPIReadCPULoad()

Monitor cpu load, returns time busy / time idle as a number between 0 and 1.

double OSAPIReadMemoryFree(double *free = 0, double *total = 0)

Monitor memory load, returns memory free bytes.

int OSAPISelect(const std::vector<OSAPIFILEDESCRIPTOR> &fds, fd_set *fdset, unsigned int timeoutMs)

Wrapper of select() function. Example:

// signaller thread:
OSAPIEventWithFd osapiEvent;
osapiEvent.Set();
...
// listener thread:
#include <OSAPI/Process/OSAPIProcess.h>

std::vector<OSAPIFILEDESCRIPTOR> fds;
fd_set fdset;
fds.push_back(osapiEvent.GetFd());

int ret = OSAPISelect(fds, &fdset, 10);
if(ret >= 0)
{
  if(ret > 0)
  {
    if(FD_ISSET(osapiEvent.GetFd(), &fdset))
    {
      // osapiEvent received!
    }
  }
}
else
{
  // error handling
}

void OSAPISetProcessPriority(CDP::ProcessPriority priority)

Sets this application process priority to priority

See also OSAPIGetProcessPriority.

void OSAPISetThreadPriority(CDP::ThreadPriority priority, OSAPITASK_HANDLE_TYPE threadHandle = 0)

Set thread priority for calling thread threadHandle.

See also OSAPIGetThreadPriority.

void OSAPISleep(unsigned int ms)

Release cpu for specified time interval in ms.

void OSAPISleep(unsigned int ms, unsigned int us)

Release cpu for specified time interval in msecs, usecs. Do not set too low, or the OS will spend all its time checking the timer.

void OSAPISystemMonitorsInit()

Initializes system monitors.

void OSAPIWaitForThreadToExit(OSAPITASK_HANDLE_TYPE hHandle, unsigned long ms = INFINITE)

Suspends current thread until thread with hHandle exits. Note: Linux waits infinitely for process to exit.

Macro Documentation

OSAPITASK_HANDLE_TYPE

Task/thread handle. pthread_t on Linux. HANDLE on Windows.

OSAPITASK_ID_TYPE

Task/thread id. pthread_t on Linux. unsigned long on Windows.