Threads

KosThreadCallback()

The callback function prototype is declared in the kos/thread.h file.

When a new thread is created, all registered callback functions will be called with the KosThreadCallbackReasonCreate argument. When the thread is terminated, they will be called with the KosThreadCallbackReasonDestroy argument.

KosThreadCallbackRegister()

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

This function registers a custom callback function. When a thread is created and terminated, all registered callback functions will be called.

KosThreadCallbackUnregister()

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

This function deregisters the custom callback function (removes it from the list of called functions).

KosThreadCreate()

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

This function creates a new thread.

Input parameters:

• priority must be within the interval from 0 to 31; the following priority constants are available: ThreadPriorityLowest (0), ThreadPriorityNormal (15) and ThreadPriorityHighest (31).
• stackSize is the size of the stack.
• routine is the function that will be executed in the thread.
• context is the argument that will be passed to the routine function.
• suspended lets you create a thread in the suspended state (1 means create suspended, 0 means create not suspended).

Output parameters:

• tid is the ID of the created thread.

Example

KosThreadCurrentId()

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

This function requests the TID of the calling thread.

If successful, the function returns the thread ID (TID).

KosThreadExit()

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

This function forcibly terminates the current thread with the exitCode.

KosThreadGetStack()

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

This function gets the stack of the thread with the specific tid.

Output parameter size contains the stack size.

If successful, the function returns the pointer to the beginning of the stack.

KosThreadOnce()

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

This function lets you call the defined initRoutine procedure precisely one time, even when it is called from multiple threads.

The onceControl parameter is designed to control the one-time call of the procedure.

If the procedure is successfully called, and if it was called previously, the KosThreadOnce() function returns rcOk.

KosThreadResume()

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

This function resumes the thread with the identifier tid that was created in the suspended state.

If successful, the function returns rcOk.

KosThreadSleep()

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

Suspends execution of the current thread for mdelay (in milliseconds).

If successful, the function returns rcOk.

KosThreadSuspend()

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

Permanently stops the current thread without finishing it.

The tid parameter must be equal to the identifier of the current thread (a limitation of the current implementation).

If successful, the function returns rcOk.

KosThreadTerminate()

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

This function terminates the thread of the calling process. The tid parameter defines the ID of the thread.

If the tid points to the current thread, the exitCode parameter defines the thread exit code.

If successful, the function returns rcOk.

KosThreadTlsGet()

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

This function returns the pointer to the local storage of the thread (TLS) or RTL_NULL if there is no TLS.

KosThreadTlsSet()

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

This function defines the address of the local storage for the thread (TLS).

Input argument tls contains the TLS address.

KosThreadWait()

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

This function suspends execution of the current thread until termination of the thread with the identifier tid or until the timeout (in milliseconds).

The KosThreadWait() call with a zero value for timeout is analogous to the KosThreadYield() call .

If successful, the function returns rcOk. In case of timeout, it returns rcTimeout.

KosThreadYield()

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

Passes execution of the thread that called it to the next thread.

The KosThreadYield() call is analogous to the KosThreadSleep() call with a zero value for mdelay.