debian man page for ost_runable

ost::Runable(3) 					     Library Functions Manual						   ost::Runable(3)

NAME
       ost::Runable -

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

SYNOPSIS
       #include <misc.h>

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

   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.

   Friends
       class Runlist

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

       Author:
	   David Sugar dyfet@ostel.com runable object with notify when ready.

Constructor &; Destructor Documentation
   ost::Runable::Runable () [protected]
   virtual ost::Runable::~Runable () [protected],  [virtual]
Member Function Documentation
   virtual void ost::Runable::ready (void) [protected],  [pure virtual]
       Method handler that is invoked when a wait-listed object becomes ready to run.

   bool ost::Runable::starting (Runlist *list)
       Start the object against a run list. Returns:
	   true if immediately available to run.

       Parameters:
	   list to start under.

   void ost::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]
Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						   ost::Runable(3)