timer.h

Go to the documentation of this file.

/*
 * timer.h
 *
 * Real time down counting time interval class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 19008 $
 * $Author: rjongbloed $
 * $Date: 2007-11-29 09:17:41 +0000 (Thu, 29 Nov 2007) $
 */

#ifndef _PTIMER
#define _PTIMER

#ifdef P_USE_PRAGMA
#pragma interface
#endif

class PThread;

#include <ptlib/notifier.h>

class PTimer : public PTimeInterval
{
  PCLASSINFO(PTimer, PTimeInterval);

  public:
    PTimer(
      long milliseconds = 0,  
      int seconds = 0,        
      int minutes = 0,        
      int hours = 0,          
      int days = 0            
    );
    PTimer(
      const PTimeInterval & time    
    );

    PTimer & operator=(
      DWORD milliseconds            
    );
    PTimer & operator=(
      const PTimeInterval & time    
    );

    virtual ~PTimer();

    virtual void SetInterval(
      PInt64 milliseconds = 0,  
      long seconds = 0,         
      long minutes = 0,         
      long hours = 0,           
      int days = 0              
    );

    void RunContinuous(
      const PTimeInterval & time    // New time interval for timer.
    );

    void Stop();

    PBoolean IsRunning() const;

    void Pause();

    void Resume();

    PBoolean IsPaused() const;

    void Reset();

    const PTimeInterval & GetResetTime() const;

    virtual void OnTimeout();

    const PNotifier & GetNotifier() const;

    void SetNotifier(
      const PNotifier & func  // New notifier function for the timer.
    );

    static PTimeInterval Tick();

    static unsigned Resolution();

  private:
    void Construct();

    /* Start or restart the timer from the #resetTime# variable.
       This is an internal function.
     */
    void StartRunning(
      PBoolean once   // Flag for one shot or continuous.
    );

    /* Process the timer decrementing it by the delta amount and calling the
       #OnTimeout()# when zero. This is used internally by the
       #PTimerList::Process()# function.
     */
    void Process(
      const PTimeInterval & delta,    // Time interval since last call.
      PTimeInterval & minTimeLeft     // Minimum time left till next timeout.
    );

  // Member variables
    PNotifier callback;
    // Callback function for expired timers.

    PTimeInterval resetTime;
    // The time to reset a timer to when RunContinuous() is called.

    PBoolean oneshot;
    // Timer operates once then stops.

    enum { Stopped, Starting, Running, Paused } state;
    // Timer state.


  friend class PTimerList;
    class PTimerList * timerList;


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/timer.h"
#else
#include "unix/ptlib/timer.h"
#endif
};

#endif


// End Of File ///////////////////////////////////////////////////////////////

---