/** \file IEventOwner.h
 ** \date  2005-12-07
 ** \author grymse@alhem.net
**/
/*
Copyright (C) 2005-2010  Anders Hedstrom

This library is made available under the terms of the GNU GPL, with
the additional exemption that compiling, linking, and/or using OpenSSL
is allowed.

If you would like to use this library in a closed-source application,
a separate license agreement is available. For information about
the closed-source license agreement for the C++ sockets library,
please visit http://www.alhem.net/Sockets/license.html and/or
email license@alhem.net.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
*/
#ifndef _SOCKETS_IEventOwner_H
#define _SOCKETS_IEventOwner_H

#include "sockets-config.h"
#include "IEventHandler.h"

#ifdef SOCKETS_NAMESPACE
namespace SOCKETS_NAMESPACE
{
#endif


/** Any class that wants to use timer events inherits this.
  \ingroup timer */
class IEventOwner
{
public:
  IEventOwner(IEventHandler& h);
  virtual ~IEventOwner();

  /** Schedule event.
    \param sec Seconds until event
    \param usec Microseconds until event
    \return Event ID */
  long AddEvent(long sec,long usec);
  /** Clear all events scheduled by this owner. */
  void ClearEvents();
  /** Remove one event scheduled by this owner.
    \param eid Event ID to remove */
  void RemoveEvent(long eid);
  /** Event callback will fire when time is up. */
  virtual void OnEvent(int) = 0;

  IEventHandler& GetEventHandler();
  void SetHandlerInvalid(bool x = true) {
    m_handler_invalid = x;
  }

private:
  IEventHandler& m_event_handler;
  bool m_handler_invalid;
};



#ifdef SOCKETS_NAMESPACE
}
#endif

#endif // _SOCKETS_IEventOwner_H

