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

VCF::Runnable Class Reference

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

#include <vcf/FoundationKit/Runnable.h>

Inheritance diagram for VCF::Runnable:

VCF::Thread VCFNet::SocketListeningLoop 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::Thread, and VCFNet::SocketListeningLoop.

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::Thread.


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