Sockets/IEventOwner.h

   1 /** \file IEventOwner.h
   2  **     \date  2005-12-07
   3  **     \author grymse@alhem.net
   4 **/
   5 /*
   6 Copyright (C) 2005,2007  Anders Hedstrom
   7
   8 This library is made available under the terms of the GNU GPL.
   9
  10 If you would like to use this library in a closed-source application,
  11 a separate license agreement is available. For information about
  12 the closed-source license agreement for the C++ sockets library,
  13 please visit http://www.alhem.net/Sockets/license.html and/or
  14 email license@alhem.net.
  15
  16 This program is free software; you can redistribute it and/or
  17 modify it under the terms of the GNU General Public License
  18 as published by the Free Software Foundation; either version 2
  19 of the License, or (at your option) any later version.
  20
  21 This program is distributed in the hope that it will be useful,
  22 but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 GNU General Public License for more details.
  25
  26 You should have received a copy of the GNU General Public License
  27 along with this program; if not, write to the Free Software
  28 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  29 */
  30 #ifndef _SOCKETS_IEventOwner_H
  31 #define _SOCKETS_IEventOwner_H
  32
  33 #include "sockets-config.h"
  34 #include "IEventHandler.h"
  35
  36 #ifdef SOCKETS_NAMESPACE
  37 namespace SOCKETS_NAMESPACE {
  38 #endif
  39
  40
  41 /** Any class that wants to use timer events inherits this.
  42         \ingroup timer */
  43 class IEventOwner
  44 {
  45 public:
  46         IEventOwner(IEventHandler& h);
  47         virtual ~IEventOwner();
  48
  49         /** Schedule event.
  50                 \param sec Seconds until event
  51                 \param usec Microseconds until event
  52                 \return Event ID */
  53         long AddEvent(long sec,long usec);
  54         /** Clear all events scheduled by this owner. */
  55         void ClearEvents();
  56         /** Remove one event scheduled by this owner.
  57                 \param eid Event ID to remove */
  58         void RemoveEvent(long eid);
  59         /** Event callback will fire when time is up. */
  60         virtual void OnEvent(int) = 0;
  61
  62         IEventHandler& EventHandler();
  63         void SetHandlerInvalid(bool x = true) { m_handler_invalid = x; }
  64
  65 private:
  66         IEventHandler& m_event_handler;
  67         bool m_handler_invalid;
  68 };
  69
  70
  71
  72 #ifdef SOCKETS_NAMESPACE
  73 }
  74 #endif
  75
  76 #endif // _SOCKETS_IEventOwner_H
  77