Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

TimerCallBase Class Reference

#include <MNTimerCall.h>

Inheritance diagram for TimerCallBase:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 TimerCallBase (bool clean)
virtual ~TimerCallBase ()
virtual void timer_callback (void *data, TimerCallBase *self)=0
virtual bool cleanup () const

Static Public Attributes

const bool DoClean = true
const bool DontClean = false

Constructor & Destructor Documentation

TimerCallBase::TimerCallBase bool  clean  )  [inline]
 

Pass a boolean value to this timer to determine whether the selector should delete this object or not.

Parameters:
clean Set to true when the selector should deleted the object when the timer is cancelled or expires. Set to false otherwise. False is obviously necessary for timers that are allocated on the stack or that are members of other objects.

virtual TimerCallBase::~TimerCallBase  )  [inline, virtual]
 

The destructor must be virtual because users of the class may want to derive child classes that hold additional private data.


Member Function Documentation

virtual bool TimerCallBase::cleanup  )  const [inline, virtual]
 

This function is used by selector to find out whether

  • a non-cyclic timer object should be deleted when it has triggered or when it has been cancelled
  • a cyclic timer object should be deleted when it has been cancelled. The constructor determines the return value.
    Return values:
    true if the selector should delete this object.
    false if another entity handles the deletion of this object.

virtual void TimerCallBase::timer_callback void *  data,
TimerCallBase self
[pure virtual]
 

This function is called when the timer expires. It must be overloaded by calling functions to process the timer.

Implemented in TimerCall< T >, TimerCall< TestCachingDownlink >, TimerCall< NopIntegratedSH >, TimerCall< MNRTCP >, TimerCall< TestCachingFillBuffer >, TimerCall< ActiveSH >, TimerCall< LossList >, TimerCall< SendBlockSH >, TimerCall< TestCachingProxy >, TimerCall< MNTFRCSend >, and TimerCall< RTPEncoderSH >.


Member Data Documentation

const bool TimerCallBase::DoClean = true [static]
 

const bool TimerCallBase::DontClean = false [static]
 


The documentation for this class was generated from the following file:
Generated on Sun Mar 6 13:36:21 2005 for Komssys by doxygen 1.3.8