src/Sockets/IEventHandler.h

   1 /** \file IEventHandler.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_IEventHandler_H
  31 #define _SOCKETS_IEventHandler_H
  32
  33 #include "sockets-config.h"
  34 #ifdef SOCKETS_NAMESPACE
  35 namespace SOCKETS_NAMESPACE {
  36 #endif
  37
  38
  39 class IEventOwner;
  40
  41 /** Timer event handler pure virtual base class.
  42         \ingroup timer */
  43 class IEventHandler
  44 {
  45 public:
  46         virtual ~IEventHandler() {}
  47
  48         /** Return time left until next event.
  49                 \param tv Time struct that will be filled by method
  50                 \return true if time is set for next event */
  51         virtual bool GetTimeUntilNextEvent(struct timeval *) = 0;
  52         /** Will fire events whose time has come. */
  53         virtual void CheckEvents() = 0;
  54         /** Schedule and event for an owner.
  55                 \param from Event owner
  56                 \param sec Seconds until event
  57                 \param usec Microseconds until event */
  58         virtual long AddEvent(IEventOwner *,long sec,long usec) = 0;
  59         /** Clear all events for a specific owner. */
  60         virtual void ClearEvents(IEventOwner *) = 0;
  61         /** Remove one specific event for an event owner. */
  62         virtual void RemoveEvent(IEventOwner *,long) = 0;
  63
  64 };
  65
  66
  67
  68
  69 #ifdef SOCKETS_NAMESPACE
  70 }
  71 #endif
  72
  73 #endif // _SOCKETS_IEventHandler_H