MpMMTimer.h

Go to the documentation of this file.

//  
// Copyright (C) 2007-2009 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2007-2009 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// $$

#ifndef _MpMMTimer_h_
#define _MpMMTimer_h_

// SYSTEM INCLUDES
#include <os/OsStatus.h>
#include <os/OsTime.h>
#include <os/OsNotification.h>
#include <utl/UtlString.h>

// APPLICATION INCLUDES
#include "mp/MpTypes.h"

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

class MpMMTimer
{
/* //////////////////////////////// PUBLIC //////////////////////////////// */
public:
   typedef enum 
   {
      Linear = 0,         
      Notification = 1    
   } MMTimerType;

/* =============================== CREATORS =============================== */


   static MpMMTimer *create(MMTimerType type, const UtlString &name = "");
   virtual ~MpMMTimer();


/* ============================= MANIPULATORS ============================= */


   virtual
   OsStatus setNotification(OsNotification* notification);
   virtual 
   OsStatus run(unsigned usecPeriodic) = 0;
   virtual 
   OsStatus stop() = 0;
   virtual
   OsStatus waitForNextTick();

/* ============================== ACCESSORS =============================== */


   virtual
   OsStatus getResolution(unsigned& resolution);
   virtual
   OsStatus getPeriodRange(unsigned* pMinUSecs, unsigned* pMaxUSecs = NULL);
   inline MMTimerType getTimerType() const;


/* =============================== INQUIRY ================================ */




/* ////////////////////////////// PROTECTED /////////////////////////////// */
protected:
   MMTimerType mTimerType;

   inline MpMMTimer(MMTimerType type);

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

};

/* ============================ INLINE METHODS ============================ */

MpMMTimer::MpMMTimer(MMTimerType type)
: mTimerType(type)
{
}

MpMMTimer::MMTimerType MpMMTimer::getTimerType() const
{
   return mTimerType;
}

#endif //_MpMMTimer_h_