src/Events/Events_Listener.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Events_Listener_H_
  22 #define Events_Listener_H_
  23
  24 #include <Events.h>
  25 #include <memory>
  26 #include <map>
  27
  28 class Events_Message;
  29 class Events_ID;
  30
  31 /**\class Events_Listener
  32  * \ingroup EventsLoop
  33  * \brief Base interface for any event listener.
  34  *
  35  * If some object wants to listen some events it must inherit
  36  * this class and register in the Loop.
  37  */
  38 class Events_Listener {
  39   /// map from event ID to groupped messages (for flush for groupMessages=true listeners)
  40   std::map<char*, std::shared_ptr<Events_Message> > myGroups;
  41
  42  public:
  43   //! This method is called by loop when the event is started to process.
  44   EVENTS_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage) = 0;
  45
  46   //! Listener that needs mostly grouped messages received returns true in this method.
  47   //! In this case during the message is flushed, all the new messages are grouped, not sended
  48   //! immideately and then sent in the end of flush.
  49   EVENTS_EXPORT virtual bool groupMessages() {return false;}
  50
  51 protected:
  52   //! Allows to group messages while they are flushed (for flush for groupMessages=true listeners)
  53   void groupWhileFlush(const std::shared_ptr<Events_Message>& theMessage);
  54   //! Sends myGroups on flush finish
  55   EVENTS_EXPORT void flushGrouped(const Events_ID& theID);
  56
  57   friend class Events_Loop;
  58 };
  59
  60 #endif