pthread.hxx File Reference

#include <pthread.h>
#include <stdint.h>
#include <cosmos/dso_export.h>
#include <cosmos/proc/types.hxx>

Go to the source code of this file.

Classes
class	cosmos::pthread::ID
	POSIX thread IDs for comparison of different threads objects. More...

Enumerations
enum class	cosmos::pthread::ExitValue : intptr_t
	An integer or pointer return value from a pthread. More...
enum class	cosmos::pthread::ThreadArg : intptr_t
	An integer or pointer value supplied to a pthread's entry function. More...

Functions
ID	cosmos::pthread::get_id ()
	Returns the opaque thread ID object for the calling thread.
void	cosmos::pthread::kill (const ID thread, const Signal sig)
	Send a thread-directed signal to the given POSIX thread ID.
void	cosmos::pthread::exit (const ExitValue val)
	Ends the calling thread immediately.

Detailed Description

pthread specific global types and function calls

Definition in file pthread.hxx.

Enumeration Type Documentation

ExitValue

enum class cosmos::pthread::ExitValue : intptr_t

strong

An integer or pointer return value from a pthread.

When a non-detached pthread returns or calls pthread::exit() then it can return an instance of this type which can be collected by another thread in the process by performing the join operation on the pthread handle.

Definition at line 46 of file pthread.hxx.

: intptr_t {};

ThreadArg

enum class cosmos::pthread::ThreadArg : intptr_t

strong

An integer or pointer value supplied to a pthread's entry function.

Definition at line 49 of file pthread.hxx.

: intptr_t {};

Function Documentation

exit()

COSMOS_API void cosmos::pthread::exit

(

const ExitValue

val = ExitValue{0}

)

Ends the calling thread immediately.

Ends execution of the calling thread.

The calling thread will not return. The provided val will be available for collection by other threads in the process by performing a join operation on the pthread_t handle associated with the calling thread.

Also the main thread may exit using this function (instead of returning from main(), in which case other pthreads in the process are allowed to continue running.

Definition at line 18 of file pthread.cxx.

                               {
        ::pthread_exit(reinterpret_cast<void*>(val));
        // should never happen
        std::abort();
}

get_id()

ID COSMOS_API cosmos::pthread::get_id

(

)

Returns the opaque thread ID object for the calling thread.

Definition at line 13 of file pthread.cxx.

            {
        return ID{::pthread_self()};
}

kill()

void cosmos::pthread::kill	(	const ID	thread,
		const Signal	sig )

Send a thread-directed signal to the given POSIX thread ID.

This is similar to cosmos::signal::send(ProcessID, ThreadID, Signal), but can only be used for threads in the same process and takes the POSIX thread ID instead of the Linux TID.

Definition at line 24 of file pthread.cxx.

                                             {
        const auto res = pthread_kill(thread.raw(), to_integral(sig.raw()));
 
        if (const auto error = Errno{res}; error != Errno::NO_ERROR) {
                cosmos_throw (ApiError("pthread_kill()", error));
        }
}