OsTimer.h

Go to the documentation of this file.

//
// Copyright (C) 2005-2006 SIPez LLC.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _OsTimer_h_
#define _OsTimer_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <os/OsDefs.h>
#include <os/OsMsgQ.h>
#include <os/OsDateTime.h>
#include <os/OsNotification.h>
#include <os/OsStatus.h>
#include <os/OsTime.h>
#include <utl/UtlContainable.h>
#include <os/OsBSem.h>


// DEFINES

#define CHECK_VALIDITY(x) \
            assert((x)->getContainableType() == OsTimer::TYPE)

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class OsTimer : public UtlContainable
{
   friend class OsTimerTask;
   friend class OsTimerTest;

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   enum OsTimerState
   {
         STOPPED,                
         STARTED                 
   };

   static const UtlContainableType TYPE;  
/* ============================ CREATORS ================================== */

   OsTimer(OsNotification& rNotifier 
      );

   OsTimer(OsMsgQ* pQueue,      
           intptr_t userData    
      );


   virtual ~OsTimer();

   virtual void deleteAsync();
/* ============================ MANIPULATORS ============================== */

   virtual OsStatus oneshotAt(const OsDateTime& when);

   virtual OsStatus oneshotAfter(const OsTime& offset);

   virtual OsStatus periodicAt(const OsDateTime& when, const OsTime &period);

   virtual OsStatus periodicEvery(const OsTime &offset, const OsTime &period);


   virtual OsStatus stop(UtlBoolean synchronous = TRUE);
/* ============================ ACCESSORS ================================= */

   virtual OsNotification* getNotifier(void) const;
   virtual unsigned hash() const;
   virtual UtlContainableType getContainableType() const;

   UtlBoolean getWasFired();
/* ============================ INQUIRY =================================== */

   virtual int compareTo(UtlContainable const *) const;
   virtual OsTimerState getState();

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   OsBSem          mBSem;      

   unsigned int    mApplicationState;
   UtlBoolean      mWasFired;  
   unsigned int    mTaskState; 
   UtlBoolean      mDeleting;  

   OsNotification* mpNotifier; 
   UtlBoolean      mbManagedNotifier; 

   OsTime          mExpiresAt; 
   UtlBoolean      mPeriodic;  
   OsTime          mPeriod;    

   // Copies of time values for use by timer task.
   OsTime          mQueuedExpiresAt; 
   UtlBoolean      mQueuedPeriodic; 
   OsTime          mQueuedPeriod; 

   int             mOutstandingMessages; 

   OsTimer*        mTimerQueueLink; 

   OsStatus startTimer(OsTime start,
                       UtlBoolean periodic,
                       OsTime period);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
  private:

   OsTimer(const OsTimer& rOsTimer);

   OsTimer& operator=(const OsTimer& rhs);

/* ============================ INLINE METHODS ============================ */
  protected:

   inline static UtlBoolean isStarted(int status)
   {
      return (status & 1) == 1;
   }

   inline static UtlBoolean isStopped(int status)
   {
      return (status & 1) == 0;
   }

};

#endif  // _OsTimer_h_