home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / gnu / aplusplus-1.01-src.lha / src / amiga / aplusplus-1.01 / include / aplusplus / devices / TimerC.h next >
C/C++ Source or Header  |  1994-05-04  |  3KB  |  77 lines
  1. #ifndef APP_TimerC_H
  2. #define APP_TimerC_H
  3. /******************************************************************************
  4.  **
  5.  **    C++ Class Library for the Amiga© system software.
  6.  **
  7.  **    Copyright (C) 1994 by Armin Vogt  **  EMail: armin@uni-paderborn.de
  8.  **    All Rights Reserved.
  9.  **
  10.  **    $VER: apphome:APlusPlus/devices/TimerC.h 1.04 (04.05.94) $
  11.  **    
  12.  ******************************************************************************/
  13.  
  14. #include <devices/timer.h>
  15. #include <APlusPlus/exec/PriorityList.h>
  16. #include <APlusPlus/environment/APPObject.h>
  17.  
  18.  
  19. /******************************************************************************************
  20.          » TimerC class «
  21.  
  22.    This class provides access to the timer device. Each TimerC object is dedicated to one
  23.    message port where it sends its timerequest to.
  24.    There are four units available with specific advantages (see RKM:Devices):
  25.    UNIT_MICROHZ, UNIT_VBLANK, UNIT_ECLOCK, UNIT_WAITUNTIL and UNIT_WAITECLOCK.
  26.  
  27.  ******************************************************************************************/
  28.  
  29. class TimerC : public APPObject
  30. {
  31.    private:
  32.       struct timerequest timerIO;
  33.       struct timeval time;
  34.       BOOL sent;           // indicates wether the IORequest has been sent or not.
  35.  
  36.       BOOL create(UWORD unit,struct MsgPort *replyPort);
  37.       void dispose();
  38.  
  39.    public:
  40.       TimerC(UWORD unit,struct MsgPort *replyPort);    // create a timer object to a msgport.
  41.  
  42.       virtual ~TimerC();
  43.  
  44.       // new time setting becomes active for the next timer start.
  45.       void set(ULONG secs=0,ULONG micros=0) { time.tv_secs = secs; time.tv_micro = micros; }
  46.       void changeReplyPort(UWORD unit,struct MsgPort *newReplyPort);
  47.  
  48.       /** activate timer: send to timer device, will be put into the replyPort's message queue
  49.        ** after set time has been elapsed (for UNIT_MICROHZ, UNIT_VBLANK, UNIT_ECLOCK) or has been
  50.        ** reached (for UNIT_WAITUNTIL and UNIT_WAITECLOCK).
  51.        **/
  52.         
  53.         BOOL start(ULONG secs = 0,ULONG micros = 0);
  54.         /** Start Timer in sending it. Only not already sent timer requests can be started.
  55.        ** If the Timer could not be started, FALSE is returned.
  56.          ** If both parameters are 0 the old time setting is used.
  57.         **/
  58.       void abort();    // results in a safely aborted timer that can be reused. (safe for non-sent timers)
  59.       BOOL reuse();    //    prepare returned Timer for next start(). If returns FALSE force with abort().
  60.         
  61.         /** Incoming messages can be identified as TimerC objects by comparing the message address
  62.          ** to the created TimerC objects:
  63.          **    TimerC timerC;
  64.          **     if (timerC.recognize(receivedMsg))    "timerC has returned"  else  "not timerC!" 
  65.          ** The class user is responsible for recognizing replied  TimerC IORequests.
  66.          **/
  67.         struct Message *getMessage() { return &timerIO.tr_node.io_Message; }
  68.         BOOL recognize(struct Message *receivedMsg) { return (getMessage()==receivedMsg); }
  69.  
  70. };
  71.  
  72. //------------ errors ----------------------------------------------------------
  73. #define TIMER_OPENDEVICE_FAILED     (TIMER_CLASS + 1)
  74. #define TIMER_CREATEEXTIO_FAILED    (TIMER_CLASS + 2)
  75.  
  76. #endif    /* APP_TimerC_H */
  77.