1 // Copyright (C) 2014-2023 CEA, EDF
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef Events_Listener_H_
21 #define Events_Listener_H_
30 /**\class Events_Listener
32 * \brief Base interface for any event listener.
34 * If some object wants to listen some events it must inherit
35 * this class and register in the Loop.
37 class Events_Listener {
38 /// map from event ID to groupped messages (for flush for groupMessages=true listeners)
39 std::map<char*, std::shared_ptr<Events_Message> > myGroups;
42 virtual ~Events_Listener() {}
44 //! This method is called by loop when the event is started to process.
45 EVENTS_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage) = 0;
47 //! Listener that needs mostly grouped messages received returns true in this method.
48 //! In this case during the message is flushed, all the new messages are grouped, not sended
49 //! immideately and then sent in the end of flush.
50 EVENTS_EXPORT virtual bool groupMessages() {return false;}
53 //! Allows to group messages while they are flushed (for flush for groupMessages=true listeners)
54 void groupWhileFlush(const std::shared_ptr<Events_Message>& theMessage);
55 //! Sends myGroups on flush finish
56 EVENTS_EXPORT void flushGrouped(const Events_ID& theID);
58 friend class Events_Loop;