1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtCore module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QABSTRACTEVENTDISPATCHER_H
43 #define QABSTRACTEVENTDISPATCHER_H
44 
45 #include <QtCore/qobject.h>
46 #include <QtCore/qeventloop.h>
47 
48 QT_BEGIN_HEADER
49 
50 QT_BEGIN_NAMESPACE
51 
52 QT_MODULE(Core)
53 
54 class QAbstractEventDispatcherPrivate;
55 class QSocketNotifier;
56 template <typename T1, typename T2> struct QPair;
57 
58 class Q_CORE_EXPORT QAbstractEventDispatcher : public QObject
59 {
60     Q_OBJECT
61     Q_DECLARE_PRIVATE(QAbstractEventDispatcher)
62 
63 public:
64     typedef QPair<int, int> TimerInfo;
65 
66     explicit QAbstractEventDispatcher(QObject *parent = 0);
67     ~QAbstractEventDispatcher();
68 
69     static QAbstractEventDispatcher *instance(QThread *thread = 0);
70 
71     virtual bool processEvents(QEventLoop::ProcessEventsFlags flags) = 0;
72     virtual bool hasPendingEvents() = 0;
73 
74     virtual void registerSocketNotifier(QSocketNotifier *notifier) = 0;
75     virtual void unregisterSocketNotifier(QSocketNotifier *notifier) = 0;
76 
77     int registerTimer(int interval, QObject *object);
78     virtual void registerTimer(int timerId, int interval, QObject *object) = 0;
79     virtual bool unregisterTimer(int timerId) = 0;
80     virtual bool unregisterTimers(QObject *object) = 0;
81     virtual QList<TimerInfo> registeredTimers(QObject *object) const = 0;
82 
83     virtual void wakeUp() = 0;
84     virtual void interrupt() = 0;
85     virtual void flush() = 0;
86 
87     virtual void startingUp();
88     virtual void closingDown();
89 
90     typedef bool(*EventFilter)(void *message);
91     EventFilter setEventFilter(EventFilter filter);
92     bool filterEvent(void *message);
93 
94 Q_SIGNALS:
95     void aboutToBlock();
96     void awake();
97 
98 protected:
99     QAbstractEventDispatcher(QAbstractEventDispatcherPrivate &,
100                              QObject *parent);
101 };
102 
103 QT_END_NAMESPACE
104 
105 QT_END_HEADER
106 
107 #endif // QABSTRACTEVENTDISPATCHER_H
108