Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::Runnable

VCF::Runnable Class Reference

A class that represents a single executable task. More...

#include <vcf/FoundationKit/Runnable.h>

Inheritance diagram for VCF::Runnable:

VCF::AsyncResult::AsyncTask VCF::AsyncResult::Task VCF::Thread VCF::ThreadedFunction< ReturnType, ClassType > VCF::ThreadedFunction1< ReturnType, ParamType1, ClassType > VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType > VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType > VCF::ThreadedFunction4< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ClassType > VCF::ThreadedFunction5< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType > VCF::ThreadedFunction6< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType > VCF::ThreadedProcedure< ClassType > VCF::ThreadedProcedure1< ParamType1, ClassType > VCF::ThreadedProcedure2< ParamType1, ParamType2, ClassType > VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType > VCF::ThreadedProcedure4< ParamType1, ParamType2, ParamType3, ParamType4, ClassType > VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType > VCF::ThreadedProcedure6< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType > VCF::ThreadedProcedure7< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ClassType > VCF::ThreadedProcedure8< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ParamType8, ClassType > VCF::ThreadedProcedure< NullClassType0 > List of all members.

Public Member Functions

virtual ~Runnable ()
virtual bool run ()=0
 Executes the runnable code.
virtual void stop ()=0
 stops the task from running.

Detailed Description

A class that represents a single executable task.

The Runnable class indicates that it may be "run' (hence the run() method) and stopped (hence the "stop" ) method.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual bool VCF::Runnable::run (   )  [pure virtual]
 

Executes the runnable code.

Returns:
returns true is the execution was suvvessful, or false if not.

Implemented in VCF::AsyncResult::AsyncTask, VCF::AsyncResult::Task, VCF::Thread, VCF::ThreadedProcedure< ClassType >, VCF::ThreadedProcedure< NullClassType0 >, VCF::ThreadedProcedure1< ParamType1, ClassType >, VCF::ThreadedProcedure2< ParamType1, ParamType2, ClassType >, VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >, VCF::ThreadedProcedure4< ParamType1, ParamType2, ParamType3, ParamType4, ClassType >, VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >, VCF::ThreadedProcedure6< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType >, VCF::ThreadedProcedure7< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ClassType >, VCF::ThreadedProcedure8< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ParamType8, ClassType >, VCF::ThreadedFunction< ReturnType, ClassType >, VCF::ThreadedFunction1< ReturnType, ParamType1, ClassType >, VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >, VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >, VCF::ThreadedFunction4< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ClassType >, VCF::ThreadedFunction5< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >, VCF::ThreadedFunction6< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType >, and VCF::PoolThread.

virtual void VCF::Runnable::stop (   )  [pure 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.

Implemented in VCF::AsyncResult::AsyncTask, VCF::AsyncResult::Task, VCF::Thread, VCF::ThreadedProcedure< ClassType >, VCF::ThreadedProcedure< NullClassType0 >, VCF::ThreadedProcedure1< ParamType1, ClassType >, VCF::ThreadedProcedure2< ParamType1, ParamType2, ClassType >, VCF::ThreadedProcedure3< ParamType1, ParamType2, ParamType3, ClassType >, VCF::ThreadedProcedure4< ParamType1, ParamType2, ParamType3, ParamType4, ClassType >, VCF::ThreadedProcedure5< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >, VCF::ThreadedProcedure6< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType >, VCF::ThreadedProcedure7< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ClassType >, VCF::ThreadedProcedure8< ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ParamType7, ParamType8, ClassType >, VCF::ThreadedFunction< ReturnType, ClassType >, VCF::ThreadedFunction1< ReturnType, ParamType1, ClassType >, VCF::ThreadedFunction2< ReturnType, ParamType1, ParamType2, ClassType >, VCF::ThreadedFunction3< ReturnType, ParamType1, ParamType2, ParamType3, ClassType >, VCF::ThreadedFunction4< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ClassType >, VCF::ThreadedFunction5< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ClassType >, and VCF::ThreadedFunction6< ReturnType, ParamType1, ParamType2, ParamType3, ParamType4, ParamType5, ParamType6, ClassType >.

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information