Threading

Collaboration diagram for Threading:

Data Structures
struct	os_thread_t
	a thread handle More...
struct	os_mutex_t
	a mutex handle More...
typedef unsigned	os_status_t
	thread return code More...
typedef size_t	os_thread_id_t
	thread id More...
CT_NORETURN CT_OS_API	os_thread_exit (os_status_t status)
	exit the current thread of execution More...
CT_OS_API os_thread_id_t	os_get_thread_id (void)
	get the current thread id More...
typedef os_exitcode_t(*	os_thread_fn_t) (void *arg)
CT_OS_API os_error_t	os_library_open (const char *path, OUT_NOTNULL os_library_t *library)
	open a shared library from disk More...
CT_OS_API os_error_t	os_library_close (STA_RELEASE os_library_t *library)
	close a shared library More...
CT_NODISCARD CT_OS_API os_error_t	os_library_symbol (os_library_t *library, OUT_NOTNULL void **symbol, const char *name)
	get a symbol from a shared library More...
CT_NODISCARD CT_OS_API const char *	os_library_name (const os_library_t *library)
	get the name of a shared library More...
CT_OS_API os_error_t	os_thread_init (OUT_NOTNULL os_thread_t *thread, const char *name, os_thread_fn_t fn, void *arg)
CT_OS_API os_error_t	os_thread_join (os_thread_t *thread, OUT_NOTNULL os_status_t *status)
CT_OS_API const char *	os_thread_name (const os_thread_t *thread)
CT_OS_API bool	os_thread_cmpid (const os_thread_t *thread, os_thread_id_t id)

Detailed Description

Typedef Documentation

os_status_t

typedef unsigned os_status_t

thread return code

Definition at line 71 of file core.h.

os_thread_fn_t

typedef os_exitcode_t(* os_thread_fn_t) (void *arg)

Definition at line 73 of file os.h.

os_thread_id_t

typedef size_t os_thread_id_t

thread id

Definition at line 75 of file core.h.

Function Documentation

os_get_thread_id()

CT_OS_API os_thread_id_t os_get_thread_id

(

void

)

get the current thread id

Returns

the current thread id

Definition at line 56 of file thread.c.

os_library_close()

CT_OS_API os_error_t os_library_close

(

STA_RELEASE os_library_t *

library

)

close a shared library

Parameters

library

the library to close

os_library_name()

CT_NODISCARD CT_OS_API const char* os_library_name

(

const os_library_t *

library

)

get the name of a shared library

Parameters

library

the library to get the name of

Returns

the name of the library

Definition at line 235 of file os.c.

os_library_open()

CT_OS_API os_error_t os_library_open	(	const char *	path,
		OUT_NOTNULL os_library_t *	library
	)

open a shared library from disk

Parameters

path	the path to the library to open
library	the library handle to fill

Returns

0 on success, error otherwise

os_library_symbol()

CT_NODISCARD CT_OS_API os_error_t os_library_symbol	(	os_library_t *	library,
		OUT_NOTNULL void **	symbol,
		const char *	name
	)

get a symbol from a shared library

Parameters

library	the library to get the symbol from
symbol	the symbol to fill
name	the name of the symbol to get

Returns

the symbol or NULL if it could not be found

os_thread_cmpid()

CT_OS_API bool os_thread_cmpid	(	const os_thread_t *	thread,
		os_thread_id_t	id
	)

Definition at line 477 of file os.c.

os_thread_exit()

CT_NORETURN CT_OS_API os_thread_exit

(

os_status_t

status

)

exit the current thread of execution

Parameters

status

the status code

Definition at line 26 of file os.c.

os_thread_init()

CT_OS_API os_error_t os_thread_init	(	OUT_NOTNULL os_thread_t *	thread,
		const char *	name,
		os_thread_fn_t	fn,
		void *	arg
	)

os_thread_join()

CT_OS_API os_error_t os_thread_join	(	os_thread_t *	thread,
		OUT_NOTNULL os_status_t *	status
	)

os_thread_name()

CT_OS_API const char* os_thread_name

(

const os_thread_t *

thread

)

thread operations

Definition at line 469 of file os.c.