vl_thread.h File Reference

#include "vl_numtypes.h"

Include dependency graph for vl_thread.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	VL_THREAD_LOCAL   _Thread_local
#define	VL_THREAD_NULL   0

Typedefs
typedef vl_uintptr_t	vl_thread
typedef void(*	vl_thread_proc) (void *usr)

Functions
vl_thread	vlThreadNew (vl_thread_proc, void *userArg)
	Creates and begins executing a new thread.
void	vlThreadDelete (vl_thread thread)
	Deletes the specified thread.
vl_bool_t	vlThreadJoin (vl_thread thread)
	Joins the specified thread, halting the calling thread until the specified thread exits.
vl_bool_t	vlThreadJoinTimeout (vl_thread thread, vl_uint_t milliseconds)
	Attempts to join the specified thread until a maximum amount of time has passed.
vl_thread	vlThreadCurrent ()
	Gets the current thread.
vl_bool_t	vlThreadYield ()
	Yields the execution of the current thread, allowing another thread to take the remainder of its timeslice.
void	vlThreadSleep (vl_ularge_t milliseconds)
	Sleeps the current thread a specified total number of milliseconds.
void	vlThreadExit ()
	Exits the calling thread.

Macro Definition Documentation

VL_THREAD_LOCAL

#define VL_THREAD_LOCAL   _Thread_local

VL_THREAD_NULL

#define VL_THREAD_NULL   0

Typedef Documentation

vl_thread

typedef vl_uintptr_t vl_thread

vl_thread_proc

typedef void(* vl_thread_proc) (void *usr)

Function Documentation

vlThreadCurrent()

vl_thread vlThreadCurrent

(

)

Gets the current thread.

Returns

vl_thread representing the current thread.

Here is the caller graph for this function:

vlThreadDelete()

void vlThreadDelete

(

vl_thread

thread

)

Deletes the specified thread.

Warning

This will result in undefined behavior if the thread has not been joined prior to calling this function.

See also

vlThreadJoin

vlThreadJoinTimeout

Parameters

thread

which thread to delete

vlThreadExit()

void vlThreadExit

(

)

Exits the calling thread.

Note

Does not return to the caller.

vlThreadJoin()

vl_bool_t vlThreadJoin

(

vl_thread

thread

)

Joins the specified thread, halting the calling thread until the specified thread exits.

Note

If the specified thread happens to be the main thread, this will return false.

Parameters

thread

Returns

true on success, false on error.

vlThreadJoinTimeout()

vl_bool_t vlThreadJoinTimeout	(	vl_thread	thread,
		vl_uint_t	milliseconds )

Attempts to join the specified thread until a maximum amount of time has passed.

Note

Will always return false is trying to join the main thread.

Parameters

thread
milliseconds

Returns

true on success, false on timeout or error.

vlThreadNew()

vl_thread vlThreadNew	(	vl_thread_proc	threadProc,
		void *	userArg )

Creates and begins executing a new thread.

Note

May return VL_THREAD_NULL on failure.

Parameters

userArg

argument pointer

Returns

thread handle

Here is the call graph for this function:

vlThreadSleep()

void vlThreadSleep

(

vl_ularge_t

milliseconds

)

Sleeps the current thread a specified total number of milliseconds.

Parameters

milliseconds

vlThreadYield()

vl_bool_t vlThreadYield

(

)

Yields the execution of the current thread, allowing another thread to take the remainder of its timeslice.

Returns

a boolean indicating if the yield operation occurred. May return false if there is no other thread to yield to.