class EE::System::Thread¶

Overview¶

#include <thread.hpp>

class Thread: private EE::NonCopyable {
public:
    // typedefs

    typedef void (*FuncType)(void *);

    // construction

    template <typename F>
    Thread(F function);

    template <typename F, typename A>
    Thread(F function, A argument);

    template <typename C>
    Thread(void(C::*)() function, C* object);
    virtual ~Thread();

    // methods

    static Uint32 getCurrentThreadId();
    void launch();
    void wait();
    void terminate();
    Uint32 getId();
};

Detailed Documentation¶

Thread manager class.

Construction¶

template <typename F>
Thread(F function)

Construct the thread from a functor with no argument This constructor works for function objects, as well as free function. Use this constructor for this kind of function:

void function();

--- or ----

struct Functor
{
    void operator()();
};

Note: this does not run the thread, use Launch().

Parameters:

function

Functor or free function to use as the entry point of the thread

template <typename F, typename A>
Thread(F function, A argument)

Construct the thread from a functor with an argument This constructor works for function objects, as well as free function. It is a template, which means that the argument can have any type (int, std::string, void*, Toto, …). Use this constructor for this kind of function:

void function(int arg);

--- or ----

struct Functor
{
    void operator()(std::string arg);
};

Note: this does not run the thread, use Launch().

Parameters:

function	Functor or free function to use as the entry point of the thread
argument	argument to forward to the function

template <typename C>
Thread(void(C::*)() function, C* object)

Construct the thread from a member function and an object This constructor is template, which means that you can use it with any class. Use this constructor for this kind of function:

class MyClass
{
    public :
        void function();
};

Note: this does not run the thread, use Launch().

Parameters:

function	Entry point of the thread
object	Pointer to the object to use

virtual ~Thread()

Destructor This destructor calls Wait(), so that the internal thread cannot survive after its Thread instance is destroyed.

Methods¶

static Uint32 getCurrentThreadId()

Returns:

The current thread id

void launch()

Run the thread This function starts the entry point passed to the thread’s constructor, and returns immediately. After this function returns, the thread’s function is running in parallel to the calling code.

void wait()

Wait until the thread finishes. This function will block the execution until the thread’s function ends. Warning: if the thread function never ends, the calling thread will block forever. If this function is called from its owner thread, it returns without doing anything.

void terminate()

Terminate the thread This function immediately stops the thread, without waiting for its function to finish. Terminating a thread with this function is not safe, and can lead to local variables not being destroyed on some operating systems. You should rather try to make the thread function terminate by itself.

Uint32 getId()

Returns:

The id of the thread