EXT Win Library - threadc

The win::threadc template encapsulates a thread as an object created over specified class/object member function.

---

Interface:

template <typename C, int (C::*P) (void *), unsigned int stack = 0>
class win::threadc {
    public:
        explicit threadc (void * = 0);
        explicit threadc (C & c, void * = 0);
        ~threadc () throw ();

    private:
        threadc (const threadc &);
        threadc & operator = (const threadc &);

    public:
        bool running () const throw ();
        bool failed () const throw ();

        int  result () const throw ();
        void wait () const throw ();
};

• typename C
  
• int (C::*P) (void *)
  P is a pointer to the member function of C that is to be executed in separate thread.
• unsigned int stack
  The stack parameter specifies the initial stack size for newly created thread. Default value of zero tells the operating system to allocate default amount of memory. See MSDN for details.
• win::thread::thread (void *)
  win::thread::thread (C &, void *)
  If the C & parameter is provided, the thread procedure is executed in context of the passed object. Otherwise a temporary object of type C is created and held for the lifetime of the win::threadc object. The void * constructor parameter is passed as a parameter to the function executed in newly-created thread. The default value is NULL.
• win::thread::running ()
  Returns true if the thread is still running or false if the thread already exited.
• win::thread::failed ()
  Returns true if the thread finished due to an uncaught exception. The value of result member function is set to -1.
• win::thread::result ()
  Returns the return value of the thread procedure. The result is undefined if the thread hasn't finished yet.
• win::thread::wait ()
  The wait member function suspends calling thread until the thread finishes. If the thread has already finished, the function returns immediately. This is called also internally in destructor of the win::thread. No return value.

Details:

The thread is considered an object. It is created when the object is constructed and finishes along with destruction of the object or sooner. The destructor waits until the thread procedure ends. The thread object cannot be copied.

To define the thread class provide a class name, pointer to a member function and optionaly initial stack size for the thread to the win::threadc template. When creating the object you may pass a reference to an object in whose context the member function is executed. If no reference is provided a temporary object of the class C is created. You may also pass a optional parameter of void * type (defaults to NULL) that is provided to the member function executed in the thread.

You will need to include "ext/win_bits/thread.cpp" into your project in order to use win::threadc.

Examples:

#include <ext/win>

class Class {
    int Procedure (void *) {
        // ...
        return 0;
    };
};

int main () {
    win::thread <Class, &Class::Procedure> thread;
    win::thread <Class, &Class::Procedure> thread (ptr);

    Class c;
    win::thread <Class, &Class::Procedure> thread (c);
    win::thread <Class, &Class::Procedure> thread (c, ptr);
    // ...
    return 0;
};

Remarks

Use win::thread template to create threads on first-class functions.

---

[index]