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
37namespace Pt {
38
39namespace System {
40
41class EventSource;
42
55class PT_SYSTEM_API EventSink : private NonCopyable
56{
57 friend class EventSource;
58
59 public:
63
66 virtual ~EventSink();
67
70 void commitEvent(const Event& ev);
71
74 void queueEvent(const Event& ev);
75
78 void wake();
79
80 protected:
83 virtual void onCommitEvent(const Event& ev) = 0;
84
87 virtual void onQueueEvent(const Event& ev) = 0;
88
91 virtual void onWake() = 0;
92
93 private:
95 void onConnect(EventSource& source);
96
98 void onDisconnect(EventSource& source);
99
101 void onUnsubscribe(EventSource& source);
102
103 private:
104 mutable RecursiveMutex _mutex;
105 std::list<EventSource*> _sources;
106};
107
108} // namespace System
109
110} // namespace Pt
111
112#endif // PT_SYSTEM_EVENTSINK_H
Base class for typed events.
Definition Event.h:66
NonCopyable()
Default constructor.
Definition NonCopyable.h:63
virtual void onQueueEvent(const Event &ev)=0
Only queues an event.
virtual void onCommitEvent(const Event &ev)=0
Queues an event and triggers event processing.
void commitEvent(const Event &ev)
Queues an event and triggers event processing.
virtual ~EventSink()
Destructor.
EventSink()
Default Constructor.
void queueEvent(const Event &ev)
Only queues an event.
void wake()
Triggers event processing.
virtual void onWake()=0
Triggers event processing.
Sends events to sinks in other threads.
Definition EventSource.h:62
Recursive mutual exclusion device.
Definition Mutex.h:190
System programming
Definition Connection.h:26
Core module.
Definition Allocator.h:33