1 // File: Events_Loop.hxx
2 // Created: Thu Mar 13 2014
3 // Author: Mikhail PONIKAROV
8 #include <Events_Message.h>
9 #include <Events_Listener.h>
15 class Events_MessageGroup;
19 * \brief Base class that manages the receiving and sending of all
20 * not Qt-events in the application.
22 * One per application, initialized on start. Listeners must register in this loop
23 * to get events, called by senders. Sending of events is very fast (just adding to container).
24 * Performing of events is processed in separated thread, so, sender takes
25 * control back immideately.
29 /// map from event ID to sender pointer to listeners that must be called for this
30 std::map<char*, std::map<void*, std::list<Events_Listener*> > > myListeners;
32 /// map from event ID to listeners which must process message without waiting for flush
33 std::map<char*, Events_Listener*> myImmediateListeners;
35 /// map from event ID to groupped messages (accumulated on flush)
36 std::map<char*, boost::shared_ptr<Events_Message> > myGroups;
38 ///< set of messages that are flushed right now, so they are not grouped
39 std::set<char*> myFlushed;
41 /// to process flushes or not
44 //! The empty constructor, will be called at startup of the application, only once
45 Events_Loop() : myFlushActive(true) {}
48 ///! Returns the main object of the loop, one per application.
49 EVENTS_EXPORT static Events_Loop* loop();
50 //! Returns the unique event by the given name. Call this method only on initialization of object
51 //! to speedup the events processing without parsing of the string.
52 EVENTS_EXPORT static Events_ID eventByName(const char* theName);
54 //! Allows to send an event
55 //! \param isGroup is true for grouping messages if possible
56 EVENTS_EXPORT void send(const boost::shared_ptr<Events_Message>& theMessage, bool isGroup = true);
58 //! Registers (or adds if such listener is already registered) a listener
59 //! that will be called on the event and from the defined sender
60 EVENTS_EXPORT void registerListener(Events_Listener* theListener, const Events_ID theID,
61 void* theSender = 0, bool theImmediate = false);
63 //! Initializes sending of a group-message by the given ID
64 EVENTS_EXPORT void flush(const Events_ID& theID);
66 //! Allows to disable flushes: needed in synchronization of document mechanism
67 //! (to synchronize all and only then flush create, update, etc in correct order)
68 EVENTS_EXPORT void activateFlushes(const bool theActivate);
70 //! Clears all collected messages
71 EVENTS_EXPORT void clear(const Events_ID& theID);
73 //! Enables flush without grouping for the given message
74 EVENTS_EXPORT void autoFlush(const Events_ID& theID, const bool theAuto = true);