summaryrefslogtreecommitdiffhomepage
path: root/SDK/Libraries/CoreSystem/Headers/Thread.h
blob: 15b40df39e37ae2147e7f3d3dca92f6ddf521d29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/* -------------------------------------------

	Copyright SoftwareLabs

------------------------------------------- */

//
// Created by Amlal on 3/18/24
//

#ifndef __THREAD__
#define __THREAD__

#include <Headers/Defines.h>

#define kThreadErrorExit (-33)

/// @brief Thread reference.
typedef QWordType ThreadRef;

/// @brief Main application thread.
CS_EXTERN_C ThreadRef kMainThread;

typedef VoidType (*ThreadEntrypointKind)(VoidType);

/// @brief Creates a new thread, and runs the code.
/// @param threadName the thread's name.
/// @param threadStart where to start.
/// @return
CS_EXTERN_C ThreadRef CSThreadCreate(const CharacterTypeUTF8* threadName, ThreadEntrypointKind threadStart);

/// @brief Dispoes the thread, and exits with code kThreadErrorExit
/// @param ref the thread reference.
/// @return  nothing.
CS_EXTERN_C VoidType CSThreadRelease(ThreadRef ref);

/// @brief Waits for the thread to complete.
/// @param ref the thread reference.
/// @return  nothing.
CS_EXTERN_C VoidType CSThreadJoin(ThreadRef ref);

/// @brief Yields the current thread.
/// @param ref the thead reference.
/// @return
CS_EXTERN_C VoidType CSThreadYield(ThreadRef ref);

#endif // __THREAD__