Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | Friends
Runable Class Referenceabstract

A container for objects that can be queued against a runlist. More...

#include <misc.h>

Collaboration diagram for Runable:
Collaboration graph
[legend]

Public Member Functions

bool starting (Runlist *list)
 Start the object against a run list. More...
 
void stoping (void)
 Stop the object, called when stopping or ready completes. More...
 

Protected Member Functions

 Runable ()
 
virtual ~Runable ()
 
virtual void ready (void)=0
 Method handler that is invoked when a wait-listed object becomes ready to run. More...
 

Private Attributes

Runlistlist
 
Runablenext
 
Runableprev
 

Friends

class Runlist
 

Detailed Description

A container for objects that can be queued against a runlist.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m runable object with notify when ready.

Definition at line 757 of file misc.h.

Constructor & Destructor Documentation

Runable::Runable ( )
protected
virtual Runable::~Runable ( )
protectedvirtual

Member Function Documentation

virtual void Runable::ready ( void  )
protectedpure virtual

Method handler that is invoked when a wait-listed object becomes ready to run.

bool Runable::starting ( Runlist list)

Start the object against a run list.

Returns
true if immediately available to run.
Parameters
listto start under.
void Runable::stoping ( void  )

Stop the object, called when stopping or ready completes.

May also be used for a task that has not yet started to remove it from the wait list.

Friends And Related Function Documentation

friend class Runlist
friend

Definition at line 760 of file misc.h.

Field Documentation

Runlist* Runable::list
private

Definition at line 761 of file misc.h.

Runable* Runable::next
private

Definition at line 762 of file misc.h.

Runable * Runable::prev
private

Definition at line 762 of file misc.h.


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