Synchronization primitives

KosCondvarBroadcast()

This function is declared in the kos/condvar.h file.

This function wakes all threads from the queue of threads that are blocked by the conditional variable condvar.

KosCondvarDeinit()

This function is declared in the kos/condvar.h file.

De-initializes the conditional variable condvar.

KosCondvarInit()

This function is declared in the kos/condvar.h file.

Initializes the conditional variable condvar.

KosCondvarSignal()

This function is declared in the kos/condvar.h file.

This function wakes one thread from the queue of threads that are blocked by the conditional variable condvar.

KosCondvarWait()

This function is declared in the kos/condvar.h file.

This function blocks execution of the current thread via the conditional variable condvar until it is awakened using KosCondvarSignal() or KosCondvarBroadcast().

mutex refers to the mutex that will be used for protecting the critical section.

If successful, the function returns rcOk.

KosCondvarWaitTimeout()

This function is declared in the kos/condvar.h file.

This function blocks execution of the current thread via the conditional variable condvar until it is awakened using KosCondvarSignal() or KosCondvarBroadcast(). The thread is blocked for no more than mdelay (in milliseconds).

• mutex refers to the mutex that will be used for protecting the critical section.

This function returns rcOk if successful, or rcTimeout if it times out.

KosEventDeinit()

This function is declared in the kos/event.h file.

This function frees the resources associated with an event (deletes the event).

KosEventInit()

This function is declared in the kos/event.h file.

This function creates an event.

The created event is in a non-signaling state.

KosEventReset()

This function is declared in the kos/event.h file.

This function switches an event to the non-signaling state (resets the event).

KosEventSet()

This function is declared in the kos/event.h file.

This function switches an event to the signaling state (signals the event) and thereby wakes all threads that are waiting for it.

KosEventWait()

This function is declared in the kos/event.h file.

Waits for the event to switch to signaling state.

The reset parameter indicates whether the event should be automatically reset when the wait successfully ends.

Returns rcOk if successful.

KosEventWaitTimeout()

This function is declared in the kos/event.h file.

Waits for the event to switch to signaling state for a period of msec (milliseconds).

The reset parameter indicates whether the event should be automatically reset when the wait successfully ends.

This function returns rcOk if successful, or rcTimeout if the timeout is exceeded.

KosMutexDeinit()

This function is declared in the kos/mutex.h file.

Deletes the specified mutex.

KosMutexInit()

This function is declared in the kos/mutex.h file.

Initializes the mutex in an unlocked state.

KosMutexInitEx()

This function is declared in the kos/mutex.h file.

Initializes the mutex in an unlocked state.

To initialize a recursive mutex, you need to pass the value 1 to the recursive parameter.

KosMutexLock()

This function is declared in the kos/mutex.h file.

Captures the specified mutex.

If the mutex is already captured, the thread is locked and waits to be unlocked.

KosMutexLockTimeout()

This function is declared in the kos/mutex.h file.

Captures the specified mutex.

If the mutex is already captured, the thread is locked for mdelay and waits to be unlocked.

This function returns rcOk if successful, or rcTimeout if it times out.

KosMutexTryLock()

This function is declared in the kos/mutex.h file.

Attempts to capture the specified mutex.

This function returns rcOk if the mutex could be captured, and returns rcBusy if the mutex could not be captured because it is already captured.

KosMutexUnlock()

This function is declared in the kos/mutex.h file.

Unlocks the specified mutex.

To unlock a recursive mutex, you need to perform the same amount of KosMutexUnlock() calls to match the amount of times the recursive mutex was locked.

KosRWLockDeinit()

This function is declared in the kos/rwlock.h file.

De-initializes the read-write lock rwlock.

KosRWLockInit()

This function is declared in the kos/rwlock.h file.

Initializes the read-write lock rwlock.

KosRWLockRead()

This function is declared in the kos/rwlock.h file.

Locks the read threads.

KosRWLockTryRead()

This function is declared in the kos/rwlock.h file.

Attempts to lock the read threads.

If successful, the function returns rcOk.

KosRWLockTryWrite()

This function is declared in the kos/rwlock.h file.

Attempts to lock the write threads.

If successful, the function returns rcOk.

KosRWLockUnlock()

This function is declared in the kos/rwlock.h file.

Removes the read-write lock rwlock.

KosRWLockWrite()

This function is declared in the kos/rwlock.h file.

Locks the write threads.

KosSemaphoreDeinit()

This function is declared in the kos/semaphore.h file.

This function destroys the specified semaphore that was previously initialized by the KosSemaphoreInit() function.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore;
• rcFail if there are threads being locked by this semaphore.

KosSemaphoreInit()

This function is declared in the kos/semaphore.h file.

Initializes the defined semaphore with the initial count value.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore;
• rcFail if the count value exceeds KOS_SEMAPHORE_VALUE_MAX.

KosSemaphoreSignal()

This function is declared in the kos/semaphore.h file.

Frees (signals) the defined semaphore.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore.

KosSemaphoreTryWait()

This function is declared in the kos/semaphore.h file.

Attempts to acquire the defined semaphore.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore;
• rcBusy if the semaphore is already acquired.

KosSemaphoreWait()

This function is declared in the kos/semaphore.h file.

Waits for acquisition of the defined semaphore.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore.

KosSemaphoreWaitTimeout()

This function is declared in the kos/semaphore.h file.

Waits for acquisition of the defined semaphore for a period of mdelay in milliseconds.

The function returns the following:

• rcOk if successful;
• rcInvalidArgument, if the semaphore points to an invalid semaphore;
• rcTimeout if the timeout expired.