The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::Win32Thread Class Reference

#include <Win32Thread.h>

Inheritance diagram for VCF::Win32Thread:

List of all members.

Public Member Functions
	Win32Thread (Thread *thread, bool mainThread)
virtual	~Win32Thread ()
virtual bool	start ()
	Starts (or resumes) a thread running.
virtual void	stop ()
	gracefully stops the thread and shuts it down, releasing any OS resources associated with the thread
virtual void	sleep (unsigned int milliseconds)
	causes the thread the thread to sleep for the specified number of milliseconds
virtual uint32	getThreadID ()
	returns the thread associated with this thread of execution
virtual unsigned int	getOwningProcessID ()
	returns the process ID that this thread is part of
virtual OSHandleID	getHandleID ()
	returns a handle ID for the thread.
virtual bool	isActive ()
virtual int	wait ()
virtual int	wait (uint32 milliseconds)
Static Public Member Functions
static unsigned __stdcall	threadProc (void *param)

---

Constructor & Destructor Documentation

VCF::Win32Thread::Win32Thread (  Thread *  thread, bool  mainThread )

virtual VCF::Win32Thread::~Win32Thread (   )  [virtual]

---

Member Function Documentation

virtual OSHandleID VCF::Win32Thread::getHandleID (   )  [inline, virtual]

returns a handle ID for the thread. It's use and signifigance are platform specific. On Win32 systems this is the HANDLE returned by the CreateThread/_beginthreadex() calls Implements VCF::ThreadPeer.

virtual unsigned int VCF::Win32Thread::getOwningProcessID (   )  [inline, virtual]

returns the process ID that this thread is part of Implements VCF::ThreadPeer.

virtual uint32 VCF::Win32Thread::getThreadID (   )  [inline, virtual]

returns the thread associated with this thread of execution Implements VCF::ThreadPeer.

virtual bool VCF::Win32Thread::isActive (   )  [inline, virtual]

Implements VCF::ThreadPeer.

virtual void VCF::Win32Thread::sleep (  unsigned int  milliseconds  )  [virtual]

causes the thread the thread to sleep for the specified number of milliseconds Parameters: uint32  - the number of milliseconds to sleep Implements VCF::ThreadPeer.

virtual bool VCF::Win32Thread::start (   )  [virtual]

Starts (or resumes) a thread running. Implements VCF::ThreadPeer.

virtual void VCF::Win32Thread::stop (   )  [virtual]

gracefully stops the thread and shuts it down, releasing any OS resources associated with the thread Implements VCF::ThreadPeer.

static unsigned __stdcall VCF::Win32Thread::threadProc (  void *  param  )  [static]

virtual int VCF::Win32Thread::wait (  uint32  milliseconds  )  [virtual]

Implements VCF::ThreadPeer.

virtual int VCF::Win32Thread::wait (   )  [virtual]

Implements VCF::ThreadPeer.

---

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

• vcf/FoundationKit/Win32Thread.h

Comments or Suggestions?    License Information