Public Types | Static Public Member Functions

Celartem::ThreadUtil Struct Reference

List of all members.

Public Types

typedef void(CEL_API * ThreadEntryPoint )(void *inParam)

Static Public Member Functions

static void * create (ThreadEntryPoint entryPoint, void *inParam)
static void join (void *threadHandle)
static void close (void *threadHandle)
static size_t getThreadId ()

Member Typedef Documentation

typedef void(CEL_API * Celartem::ThreadUtil::ThreadEntryPoint)(void *inParam)

The definition of the thread entry point for threadCreate function.

Parameters:
inParam The second parameter passed to threadCreate function.

Member Function Documentation

static void Celartem::ThreadUtil::close ( void *  threadHandle  )  [static]

This function closes the handle of the thread.

Parameters:
threadHandle The handle of thread.

Referenced by Celartem::Thread::join().

static void* Celartem::ThreadUtil::create ( ThreadEntryPoint  entryPoint,
void *  inParam 
) [static]

This function creates a new thread.

Parameters:
entryPoint Pointer to the thread entry point.
inParam Thread defined parameter; this parameter is passed to the function pointed by entryPoint parameter.
Returns:
This function returns a handle to the thread. The handle should be closed by calling threadClose function if no longer needed.

Referenced by Celartem::Thread::run().

static size_t Celartem::ThreadUtil::getThreadId (  )  [static]

This function returns the thread Id of the current thread.

Returns:
The thread Id of the thread.
static void Celartem::ThreadUtil::join ( void *  threadHandle  )  [static]

This function waits for the thread to finish running.

Parameters:
threadHandle The handle of thread.

The documentation for this struct was generated from the following file:

This document is made with doxygen 1.7.1 at Sat Mar 31 2012 04:35:57.
Caminova Logo