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

VCF::ThreadedProcedure< ClassType > Class Template Reference

#include <ThreadedFunctions.h>

Inheritance diagram for VCF::ThreadedProcedure< ClassType >:

List of all members.

Public Types
typedef void(ClassType::*	ClassProcPtr )()
typedef void(ClassType::*	ClassThreadProcPtr )(Thread *thread)
typedef ThreadedProcedure< ClassType >	BaseClass
Public Member Functions
	ThreadedProcedure (ClassType *src, ClassProcPtr procPtr)
	ThreadedProcedure (ClassType *src, ClassThreadProcPtr procPtr)
virtual bool	run ()
	Executes the runnable code.
virtual void	stop ()
	stops the task from running.
Runnable *	getParams ()
Thread *	invoke ()
Protected Member Functions
	ThreadedProcedure ()
Protected Attributes
Runnable *	internalParams_
Thread *	runningThread_
ClassProcPtr	classProcPtr_
ClassThreadProcPtr	classThreadProcPtr_
ClassType *	instancePtr_

template<typename ClassType = NullClassType0>
class VCF::ThreadedProcedure< ClassType >

---

Member Typedef Documentation

template<typename ClassType = NullClassType0> typedef ThreadedProcedure<ClassType> VCF::ThreadedProcedure< ClassType >::BaseClass

template<typename ClassType = NullClassType0> typedef void(ClassType::* VCF::ThreadedProcedure< ClassType >::ClassProcPtr)()

template<typename ClassType = NullClassType0> typedef void(ClassType::* VCF::ThreadedProcedure< ClassType >::ClassThreadProcPtr)(Thread *thread)

---

Constructor & Destructor Documentation

template<typename ClassType = NullClassType0> VCF::ThreadedProcedure< ClassType >::ThreadedProcedure (  ClassType *  src, ClassProcPtr  procPtr )  [inline]

template<typename ClassType = NullClassType0> VCF::ThreadedProcedure< ClassType >::ThreadedProcedure (  ClassType *  src, ClassThreadProcPtr  procPtr )  [inline]

template<typename ClassType = NullClassType0> VCF::ThreadedProcedure< ClassType >::ThreadedProcedure (   )  [inline, protected]

---

Member Function Documentation

template<typename ClassType = NullClassType0> Runnable* VCF::ThreadedProcedure< ClassType >::getParams (   )  [inline]

template<typename ClassType = NullClassType0> Thread* VCF::ThreadedProcedure< ClassType >::invoke (   )  [inline]

template<typename ClassType = NullClassType0> virtual bool VCF::ThreadedProcedure< ClassType >::run (   )  [inline, virtual]

Executes the runnable code. Returns: returns true is the execution was suvvessful, or false if not. Implements VCF::Runnable.

template<typename ClassType = NullClassType0> virtual void VCF::ThreadedProcedure< ClassType >::stop (   )  [inline, virtual]

stops the task from running. Should allow the implementer to gracefully finish whatever they were doing and exit the run() method as soon as possible. Implements VCF::Runnable.

---

Member Data Documentation

template<typename ClassType = NullClassType0> ClassProcPtr VCF::ThreadedProcedure< ClassType >::classProcPtr_ [protected]

template<typename ClassType = NullClassType0> ClassThreadProcPtr VCF::ThreadedProcedure< ClassType >::classThreadProcPtr_ [protected]

template<typename ClassType = NullClassType0> ClassType* VCF::ThreadedProcedure< ClassType >::instancePtr_ [protected]

template<typename ClassType = NullClassType0> Runnable* VCF::ThreadedProcedure< ClassType >::internalParams_ [protected]

template<typename ClassType = NullClassType0> Thread* VCF::ThreadedProcedure< ClassType >::runningThread_ [protected]

---

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

• vcf/FoundationKit/ThreadedFunctions.h

Comments or Suggestions?    License Information