OSAPI

OS API. ModuleID = 0. More...

Macros
#define	OSAPI_LOG_GET_NEXT_OBJECT_ID_EC   (OSAPI_LOG_BASE + 1)
	Retrieving the next error code failed. More...
#define	OSAPI_LOG_SYSTEM_SET_PROPERTY_EC   (OSAPI_LOG_BASE + 2)
	An error occured while setting the system properties. More...
#define	OSAPI_LOG_SYSTEM_TIMER_START_EC   (OSAPI_LOG_BASE + 4)
	An error occured when starting the system timer. More...
#define	OSAPI_LOG_SYSTEM_TIMER_STOP_EC   (OSAPI_LOG_BASE + 5)
	An error occured when stopping the system timer. More...
#define	OSAPI_LOG_THREAD_NEW_EC   (OSAPI_LOG_BASE + 6)
	An error when allocating the a thread object. More...
#define	OSAPI_LOG_THREAD_CREATE_EC   (OSAPI_LOG_BASE + 7)
	An error when creating the a thread object. More...
#define	OSAPI_LOG_THREAD_SEM_EC   (OSAPI_LOG_BASE + 8)
	An error when creating thread sync semaphore. More...
#define	OSAPI_LOG_THREAD_EXEC_CREATE_EC   (OSAPI_LOG_BASE + 9)
	Failed to signal that a thread has been created. More...
#define	OSAPI_LOG_THREAD_EXEC_START_EC   (OSAPI_LOG_BASE + 10)
	Failed to signal the start a created thread. More...
#define	OSAPI_LOG_THREAD_START_EC   (OSAPI_LOG_BASE + 11)
	Failed to start a thread. More...
#define	OSAPI_LOG_THREAD_DESTROY_EC   (OSAPI_LOG_BASE + 12)
	Failed to destroy a thread. More...
#define	OSAPI_LOG_THREAD_DESTROY_NO_START_EC   (OSAPI_LOG_BASE + 13)
	Failed to start an unstarted thread being destroyed. More...
#define	OSAPI_LOG_THREAD_DESTROY_NO_WAKEUP_EC   (OSAPI_LOG_BASE + 14)
	Failed wakeup of a thread being destroyed. More...
#define	OSAPI_LOG_THREAD_INIT_EC   (OSAPI_LOG_BASE + 15)
	Failed initializing a thread. More...
#define	OSAPI_LOG_THREAD_SCHEDPARAM_EC   (OSAPI_LOG_BASE + 16)
	Failed to set scheduling policy of a thread. More...
#define	OSAPI_LOG_THREAD_GET_POLICY_EC   (OSAPI_LOG_BASE + 17)
	Failed to get the scheduling policy of a thread. More...
#define	OSAPI_LOG_THREAD_POLICY_DIFFER_EC   (OSAPI_LOG_BASE + 18)
	Mismatch of scheduling policy of a created thread and the application thread. More...
#define	OSAPI_LOG_THREAD_PRIORITY_MAP_EC   (OSAPI_LOG_BASE + 19)
	Failed to map to native thread priority values. More...
#define	OSAPI_LOG_TIMER_DELETE_EC   (OSAPI_LOG_BASE + 20)
	Failed to delete the Timer object. More...
#define	OSAPI_LOG_TIMER_TICK_MUTEX_EC   (OSAPI_LOG_BASE + 22)
	Failed taking or giving the Timer mutex. More...
#define	OSAPI_LOG_TIMER_GET_USER_DATA_EPOCH_EC   (OSAPI_LOG_BASE + 27)
	Failed to return user data for a timeout due to mismatched epochs. More...
#define	OSAPI_LOG_TIMER_NEW_EC   (OSAPI_LOG_BASE + 28)
	Failed to allocate memory for a new Timer. More...
#define	OSAPI_LOG_TIMER_NEW_ENTRY_EC   (OSAPI_LOG_BASE + 29)
	Failed to allocate memory for a new Timer entry. More...
#define	OSAPI_LOG_TIMER_NEW_WHEEL_EC   (OSAPI_LOG_BASE + 30)
	Failed to allocate memory for a new Timer wheel. More...
#define	OSAPI_LOG_TIMER_NEW_MUTEX_EC   (OSAPI_LOG_BASE + 31)
	Failed to create a new Timer mutex. More...
#define	OSAPI_LOG_TIMER_NEW_START_TIMER_EC   (OSAPI_LOG_BASE + 32)
	Failed to start a new Timer being created. More...
#define	OSAPI_LOG_TIMER_DELETE_STOP_TIMER_EC   (OSAPI_LOG_BASE + 33)
	Failed to stop a Timer being deleted. More...
#define	OSAPI_LOG_TIMER_DELETE_MUTEX_EC   (OSAPI_LOG_BASE + 34)
	Failed to delete the Timer mutex. More...
#define	OSAPI_LOG_TIMER_MUTEX_EC   (OSAPI_LOG_BASE + 35)
	Failed to take or give a Timer mutex. More...
#define	OSAPI_LOG_SEMAPHORE_DELETE_EC   (OSAPI_LOG_BASE + 36)
	Failed to delete a semaphore. More...
#define	OSAPI_LOG_SEMAPHORE_NEW_EC   (OSAPI_LOG_BASE + 37)
	Failed to create a semaphore. More...
#define	OSAPI_LOG_SEMAPHORE_NEW_INIT_EC   (OSAPI_LOG_BASE + 38)
	Failed to initialize a new semaphore. More...
#define	OSAPI_LOG_SEMAPHORE_GIVE_EC   (OSAPI_LOG_BASE + 39)
	Failed to give a semaphore. More...
#define	OSAPI_LOG_SEMAPHORE_TAKE_EC   (OSAPI_LOG_BASE + 40)
	Failed to take a semaphore. More...
#define	OSAPI_LOG_MUTEX_DELETE_EC   (OSAPI_LOG_BASE + 41)
	Failed to delete a mutex. More...
#define	OSAPI_LOG_MUTEX_NEW_EC   (OSAPI_LOG_BASE + 42)
	Failed to create a mutex. More...
#define	OSAPI_LOG_MUTEX_TAKE_EC   (OSAPI_LOG_BASE + 43)
	Failed to take a mutex. More...
#define	OSAPI_LOG_MUTEX_GIVE_EC   (OSAPI_LOG_BASE + 44)
	Failed to give a mutex. More...
#define	OSAPI_LOG_MUTEX_INIT_EC   (OSAPI_LOG_BASE + 45)
	Failed to initialize a mutex. More...
#define	OSAPI_LOG_HEAP_INTERNAL_ALLOCATE_EC   (OSAPI_LOG_BASE + 46)
	Failed to allocate a buffer from the heap. More...
#define	OSAPI_LOG_SYSTEM_GET_TIME_EC   (OSAPI_LOG_BASE + 48)
	Failed to get current system time. More...
#define	OSAPI_LOG_LAST_RECORDED_ERROR_EC   (OSAPI_LOG_BASE + 49)
	Return the last recorded error-code for the calling thread. More...
#define	OSAPI_LOG_SET_THREAD_NAME_EC   (OSAPI_LOG_BASE + 50)
	Failed to set the thread name in the OS. More...

Detailed Description

OS API. ModuleID = 0.

The logging API provides a number of functions for logging different types of events. There are 3 types of events:

info - This type is for informational purposes

warning - This type does not necessarily cause any functional behavior, but could indicate an unexpected situation has been handled or performance could be affected.

error - This indicated an error condition that has functional impact and could not be dealt with.

Macro Definition Documentation

#define OSAPI_LOG_GET_NEXT_OBJECT_ID_EC   (OSAPI_LOG_BASE + 1)

Retrieving the next error code failed.

#define OSAPI_LOG_SYSTEM_SET_PROPERTY_EC   (OSAPI_LOG_BASE + 2)

An error occured while setting the system properties.

#define OSAPI_LOG_SYSTEM_TIMER_START_EC   (OSAPI_LOG_BASE + 4)

An error occured when starting the system timer.

#define OSAPI_LOG_SYSTEM_TIMER_STOP_EC   (OSAPI_LOG_BASE + 5)

An error occured when stopping the system timer.

#define OSAPI_LOG_THREAD_NEW_EC   (OSAPI_LOG_BASE + 6)

An error when allocating the a thread object.

#define OSAPI_LOG_THREAD_CREATE_EC   (OSAPI_LOG_BASE + 7)

An error when creating the a thread object.

#define OSAPI_LOG_THREAD_SEM_EC   (OSAPI_LOG_BASE + 8)

An error when creating thread sync semaphore.

#define OSAPI_LOG_THREAD_EXEC_CREATE_EC   (OSAPI_LOG_BASE + 9)

Failed to signal that a thread has been created.

#define OSAPI_LOG_THREAD_EXEC_START_EC   (OSAPI_LOG_BASE + 10)

Failed to signal the start a created thread.

#define OSAPI_LOG_THREAD_START_EC   (OSAPI_LOG_BASE + 11)

Failed to start a thread.

#define OSAPI_LOG_THREAD_DESTROY_EC   (OSAPI_LOG_BASE + 12)

Failed to destroy a thread.

#define OSAPI_LOG_THREAD_DESTROY_NO_START_EC   (OSAPI_LOG_BASE + 13)

Failed to start an unstarted thread being destroyed.

#define OSAPI_LOG_THREAD_DESTROY_NO_WAKEUP_EC   (OSAPI_LOG_BASE + 14)

Failed wakeup of a thread being destroyed.

#define OSAPI_LOG_THREAD_INIT_EC   (OSAPI_LOG_BASE + 15)

Failed initializing a thread.

#define OSAPI_LOG_THREAD_SCHEDPARAM_EC   (OSAPI_LOG_BASE + 16)

Failed to set scheduling policy of a thread.

#define OSAPI_LOG_THREAD_GET_POLICY_EC   (OSAPI_LOG_BASE + 17)

Failed to get the scheduling policy of a thread.

#define OSAPI_LOG_THREAD_POLICY_DIFFER_EC   (OSAPI_LOG_BASE + 18)

Mismatch of scheduling policy of a created thread and the application thread.

#define OSAPI_LOG_THREAD_PRIORITY_MAP_EC   (OSAPI_LOG_BASE + 19)

Failed to map to native thread priority values.

#define OSAPI_LOG_TIMER_DELETE_EC   (OSAPI_LOG_BASE + 20)

Failed to delete the Timer object.

#define OSAPI_LOG_TIMER_TICK_MUTEX_EC   (OSAPI_LOG_BASE + 22)

Failed taking or giving the Timer mutex.

#define OSAPI_LOG_TIMER_GET_USER_DATA_EPOCH_EC   (OSAPI_LOG_BASE + 27)

Failed to return user data for a timeout due to mismatched epochs.

#define OSAPI_LOG_TIMER_NEW_EC   (OSAPI_LOG_BASE + 28)

Failed to allocate memory for a new Timer.

#define OSAPI_LOG_TIMER_NEW_ENTRY_EC   (OSAPI_LOG_BASE + 29)

Failed to allocate memory for a new Timer entry.

#define OSAPI_LOG_TIMER_NEW_WHEEL_EC   (OSAPI_LOG_BASE + 30)

Failed to allocate memory for a new Timer wheel.

#define OSAPI_LOG_TIMER_NEW_MUTEX_EC   (OSAPI_LOG_BASE + 31)

Failed to create a new Timer mutex.

#define OSAPI_LOG_TIMER_NEW_START_TIMER_EC   (OSAPI_LOG_BASE + 32)

Failed to start a new Timer being created.

#define OSAPI_LOG_TIMER_DELETE_STOP_TIMER_EC   (OSAPI_LOG_BASE + 33)

Failed to stop a Timer being deleted.

#define OSAPI_LOG_TIMER_DELETE_MUTEX_EC   (OSAPI_LOG_BASE + 34)

Failed to delete the Timer mutex.

#define OSAPI_LOG_TIMER_MUTEX_EC   (OSAPI_LOG_BASE + 35)

Failed to take or give a Timer mutex.

#define OSAPI_LOG_SEMAPHORE_DELETE_EC   (OSAPI_LOG_BASE + 36)

Failed to delete a semaphore.

#define OSAPI_LOG_SEMAPHORE_NEW_EC   (OSAPI_LOG_BASE + 37)

Failed to create a semaphore.

#define OSAPI_LOG_SEMAPHORE_NEW_INIT_EC   (OSAPI_LOG_BASE + 38)

Failed to initialize a new semaphore.

#define OSAPI_LOG_SEMAPHORE_GIVE_EC   (OSAPI_LOG_BASE + 39)

Failed to give a semaphore.

#define OSAPI_LOG_SEMAPHORE_TAKE_EC   (OSAPI_LOG_BASE + 40)

Failed to take a semaphore.

#define OSAPI_LOG_MUTEX_DELETE_EC   (OSAPI_LOG_BASE + 41)

Failed to delete a mutex.

#define OSAPI_LOG_MUTEX_NEW_EC   (OSAPI_LOG_BASE + 42)

Failed to create a mutex.

#define OSAPI_LOG_MUTEX_TAKE_EC   (OSAPI_LOG_BASE + 43)

Failed to take a mutex.

#define OSAPI_LOG_MUTEX_GIVE_EC   (OSAPI_LOG_BASE + 44)

Failed to give a mutex.

#define OSAPI_LOG_MUTEX_INIT_EC   (OSAPI_LOG_BASE + 45)

Failed to initialize a mutex.

#define OSAPI_LOG_HEAP_INTERNAL_ALLOCATE_EC   (OSAPI_LOG_BASE + 46)

Failed to allocate a buffer from the heap.

#define OSAPI_LOG_SYSTEM_GET_TIME_EC   (OSAPI_LOG_BASE + 48)

Failed to get current system time.

#define OSAPI_LOG_LAST_RECORDED_ERROR_EC   (OSAPI_LOG_BASE + 49)

Return the last recorded error-code for the calling thread.

This log-messages retrieves the last recorded error-code for the calling thread. It is used a function calls another function that fails.

#define OSAPI_LOG_SET_THREAD_NAME_EC   (OSAPI_LOG_BASE + 50)

Failed to set the thread name in the OS.

When OSAPI starts a thread it also calls the OS to set the thread name. If this fails this warning message indicates why.