summaryrefslogtreecommitdiff
path: root/src/common/thread.h
diff options
context:
space:
mode:
authorHaru <haru@dotalux.com>2014-05-13 18:17:52 +0200
committerHaru <haru@dotalux.com>2014-05-13 18:17:52 +0200
commit5d67f33135a5305665f78307e03fa9aee7aa544b (patch)
tree831248cdf9994ccb9e44751d0d68220631c6d4dd /src/common/thread.h
parentc03094034f5338016221775bce4b39a0e9b75ee6 (diff)
downloadhercules-5d67f33135a5305665f78307e03fa9aee7aa544b.tar.gz
hercules-5d67f33135a5305665f78307e03fa9aee7aa544b.tar.bz2
hercules-5d67f33135a5305665f78307e03fa9aee7aa544b.tar.xz
hercules-5d67f33135a5305665f78307e03fa9aee7aa544b.zip
Removed trailing whitespace (sources)
Signed-off-by: Haru <haru@dotalux.com>
Diffstat (limited to 'src/common/thread.h')
-rw-r--r--src/common/thread.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/src/common/thread.h b/src/common/thread.h
index 887c03179..7ad326509 100644
--- a/src/common/thread.h
+++ b/src/common/thread.h
@@ -12,7 +12,7 @@ typedef void* (*rAthreadProc)(void*);
typedef enum RATHREAD_PRIO {
RAT_PRIO_LOW = 0,
RAT_PRIO_NORMAL,
- RAT_PRIO_HIGH
+ RAT_PRIO_HIGH
} RATHREAD_PRIO;
@@ -21,18 +21,18 @@ typedef enum RATHREAD_PRIO {
*
* @param entyPoint - entryProc,
* @param param - general purpose parameter, would be given as parameter to the thread's entrypoint.
- *
+ *
* @return not NULL if success
*/
rAthread rathread_create( rAthreadProc entryPoint, void *param );
-/**
+/**
* Creates a new Thread (with more creation options)
*
* @param entyPoint - entryProc,
* @param param - general purpose parameter, would be given as parameter to the thread's entrypoint
- * @param szStack - stack Size in bytes
+ * @param szStack - stack Size in bytes
* @param prio - Priority of the Thread @ OS Scheduler..
*
* @return not NULL if success
@@ -43,29 +43,29 @@ rAthread rathread_createEx( rAthreadProc entryPoint, void *param, size_t szSta
/**
* Destroys the given Thread immediatly
*
- * @note The Handle gets invalid after call! dont use it afterwards.
+ * @note The Handle gets invalid after call! dont use it afterwards.
*
* @param handle - thread to destroy.
*/
void rathread_destroy ( rAthread handle );
-/**
+/**
* Returns the thread handle of the thread calling this function
- *
+ *
* @note this wont work @ programms main thread
- * @note the underlying implementation might not perform very well, cache the value received!
- *
+ * @note the underlying implementation might not perform very well, cache the value received!
+ *
* @return not NULL if success
*/
rAthread rathread_self( );
/**
- * Returns own thrad id (TID)
+ * Returns own thrad id (TID)
*
- * @note this is an unique identifier for the calling thread, and
- * depends on platfrom / compiler, and may not be the systems Thread ID!
+ * @note this is an unique identifier for the calling thread, and
+ * depends on platfrom / compiler, and may not be the systems Thread ID!
*
* @return -1 when fails, otherwise >= 0
*/
@@ -73,26 +73,26 @@ int rathread_get_tid();
/**
- * Waits for the given thread to terminate
+ * Waits for the given thread to terminate
*
* @param handle - thread to wait (join) for
* @param out_Exitcode - [OPTIONAL] - if given => Exitcode (value) of the given thread - if it's terminated
- *
+ *
* @return true - if the given thread has been terminated.
*/
bool rathread_wait( rAthread handle, void* *out_exitCode );
-/**
+/**
* Sets the given PRIORITY @ OS Task Scheduler
- *
+ *
* @param handle - thread to set prio for
* @param rio - the priority (RAT_PRIO_LOW ... )
*/
void rathread_prio_set( rAthread handle, RATHREAD_PRIO prio );
-/**
+/**
* Gets the current Prio of the given trhead
*
* @param handle - the thread to get the prio for.
@@ -102,9 +102,9 @@ RATHREAD_PRIO rathread_prio_get( rAthread handle);
/**
* Tells the OS scheduler to yield the execution of the calling thread
- *
+ *
* @note: this will not "pause" the thread,
- * it just allows the OS to spent the remaining time
+ * it just allows the OS to spent the remaining time
* of the slice to another thread.
*/
void rathread_yield();