EventSink.h
1 /*
2  * Copyright (C) 2006-2013 Marc Boris Duerner
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * As a special exception, you may use this file as part of a free
10  * software library without restriction. Specifically, if other files
11  * instantiate templates or use macros or inline functions from this
12  * file, or you compile this file and link it with other files to
13  * produce an executable, this file does not by itself cause the
14  * resulting executable to be covered by the GNU General Public
15  * License. This exception does not however invalidate any other
16  * reasons why the executable file might be covered by the GNU Library
17  * General Public License.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22  * Lesser General Public License for more details.
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27  */
28 
29 #ifndef PT_SYSTEM_EVENTSINK_H
30 #define PT_SYSTEM_EVENTSINK_H
31 
32 #include <Pt/System/Api.h>
33 #include <Pt/System/Mutex.h>
34 #include <Pt/Event.h>
35 #include <list>
36 
37 namespace Pt {
38 
39 namespace System {
40 
41 class EventSource;
42 
45 class PT_SYSTEM_API EventSink : private NonCopyable
46 {
47  friend class EventSource;
48 
49  public:
52  EventSink();
53 
56  virtual ~EventSink();
57 
60  void commitEvent(const Event& ev);
61 
64  void queueEvent(const Event& ev);
65 
68  void wake();
69 
70  protected:
73  virtual void onCommitEvent(const Event& ev) = 0;
74 
77  virtual void onQueueEvent(const Event& ev) = 0;
78 
81  virtual void onWake() = 0;
82 
83  private:
85  void onConnect(EventSource& source);
86 
88  void onDisconnect(EventSource& source);
89 
91  void onUnsubscribe(EventSource& source);
92 
93  private:
94  mutable RecursiveMutex _mutex;
95  std::list<EventSource*> _sources;
96 };
97 
98 } // namespace System
99 
100 } // namespace Pt
101 
102 #endif // PT_SYSTEM_EVENTSINK_H
Protects derived classes from being copied.
Definition: NonCopyable.h:54
Recursive mutual exclusion device.
Definition: Mutex.h:187
Receiver for events.
Definition: EventSink.h:45
Base class for all event types.
Definition: Event.h:49
Sends Events to receivers in other threads.
Definition: EventSource.h:54