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

VCF::ThreadPeer Interface Reference

Basic Thread interface to wrap native thread OS calls. More...

#include <ThreadPeer.h>

Inheritance diagram for VCF::ThreadPeer:

List of all members.

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

---

Detailed Description

Basic Thread interface to wrap native thread OS calls.

Author:

Jim Crafton

Version:

1.0

---

Constructor & Destructor Documentation

virtual VCF::ThreadPeer::~ThreadPeer (   )  [inline, virtual]

---

Member Function Documentation

virtual OSHandleID VCF::ThreadPeer::getHandleID (   )  [pure 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 Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual uint32 VCF::ThreadPeer::getOwningProcessID (   )  [pure virtual]

returns the process ID that this thread is part of Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual uint32 VCF::ThreadPeer::getThreadID (   )  [pure virtual]

returns the thread associated with this thread of execution Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual bool VCF::ThreadPeer::isActive (   )  [pure virtual]

Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual void VCF::ThreadPeer::sleep (  uint32  milliseconds  )  [pure virtual]

causes the thread the thread to sleep for the specified number of milliseconds Parameters: uint32  - the number of milliseconds to sleep Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual bool VCF::ThreadPeer::start (   )  [pure virtual]

Starts (or resumes) a thread running. Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual void VCF::ThreadPeer::stop (   )  [pure virtual]

gracefully stops the thread and shuts it down, releasing any OS resources associated with the thread Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual int VCF::ThreadPeer::wait (  uint32  milliseconds  )  [pure virtual]

Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

virtual int VCF::ThreadPeer::wait (   )  [pure virtual]

Implemented in VCF::OSXThread, VCF::PosixThread, and VCF::Win32Thread.

---

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

• vcf/FoundationKit/ThreadPeer.h

Comments or Suggestions?    License Information