---

Event.h

#ifndef _UNEVT_Event_H_  // -*- mode: c++; c-file-style: "hopper"-*-

/*
 * Copyright (C) 1991-9 Eric M. Hopper <hopper@omnifarious.mn.org>
 * 
 *     This program is free software; you can redistribute it and/or modify it
 *     under the terms of the GNU Lesser 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
 *     Lesser General Public License for more details.
 * 
 *     You should have received a copy of the GNU Lesser General Public
 *     License along with this program; if not, write to the Free Software
 *     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifdef __GNUG__
#  pragma interface
#endif

/* $Header: /home/hopper/src/cvs/C++/UniEvent/UniEvent/Event.h,v 1.14 2002/08/29 00:58:05 hopper Exp $ */

// For log see ../ChangeLog

#include <LCore/Protocol.h>
#include <LCore/RefCounting.h>
#ifndef _UNEVT_UNEVT_ClassIdent_H_
#  include <UniEvent/UNEVT_ClassIdent.h>
#endif

#define _UNEVT_Event_H_


namespace strmod {
namespace unievent {

class Dispatcher;
class EventPtr;

/** \class Event Event.h UniEvent/Event.h
 * \brief An event to be queued up in a UNIDispatcher.
 */
class Event : virtual public lcore::Protocol, public lcore::ReferenceCounting
{
 public:
   static const UNEVT_ClassIdent identifier;

   //! Nothing exciting here.
   Event() : ReferenceCounting(0)                       { }
   //! This is an interface class, of course it has a virtual destructor.
   virtual ~Event()                                     { }

   inline virtual int AreYouA(const lcore::ClassIdent &cid) const;

   /** Perform the action associated with the event.
    * If the event was triggered by a dispatcher, the dispatcher that triggered
    * it is expected to be passed in.  Otherwise NULL (aka 0) can be passed in.
    * A dispatcher will only call ONE triggerEvent method at a time.
    */
   virtual void triggerEvent(Dispatcher *dispatcher = 0) = 0;

   /** Interrupt the current event if possible.
    * <b>MUST be thread-safe, signal-safe, and otherwise prepared to be called
    * in very strange contexts!</b>
    *
    * This method should cause the currently executing event to return as
    * quickly as possible.  This may not be possible to do for all kinds of
    * events.  This method will only be called just before, during, or just
    * after the triggerEvent() method is called.
    */
   virtual void interrupt()                             { }

   //! Alternate form of TriggerEvent
   inline void operator ()(Dispatcher *dispatcher);
   //! Alternate form of TriggerEvent
   inline void operator ()()                            { (*this)(0); }

 protected:
   virtual const lcore::ClassIdent *i_GetIdent() const  { return &identifier; }

 private:
   // Purposely left undefined.
   Event(const Event &b);
   const Event &operator =(const Event &b);
};

//-----------------------------inline functions--------------------------------

inline int Event::AreYouA(const lcore::ClassIdent &cid) const
{
   return((identifier == cid) || Protocol::AreYouA(cid));
}

inline void Event::operator ()(Dispatcher *dispatcher)
{
   triggerEvent(dispatcher);
}

} // namespace unievent
} // namespace strmod

#endif

---