1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://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 https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QCFSOCKETNOTIFIER_P_H
41 #define QCFSOCKETNOTIFIER_P_H
42 
43 //
44 //  W A R N I N G
45 //  -------------
46 //
47 // This file is not part of the Qt API.  It exists purely as an
48 // implementation detail.  This header file may change from version to
49 // version without notice, or even be removed.
50 //
51 // We mean it.
52 //
53 
54 #include <QtCore/private/qglobal_p.h>
55 #include <QtCore/qabstracteventdispatcher.h>
56 #include <QtCore/qhash.h>
57 
58 #include <CoreFoundation/CoreFoundation.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 struct MacSocketInfo {
MacSocketInfoMacSocketInfo63     MacSocketInfo() : socket(0), runloop(0), readNotifier(0), writeNotifier(0),
64         readEnabled(false), writeEnabled(false) {}
65     CFSocketRef socket;
66     CFRunLoopSourceRef runloop;
67     QObject *readNotifier;
68     QObject *writeNotifier;
69     bool readEnabled;
70     bool writeEnabled;
71 };
72 typedef QHash<int, MacSocketInfo *> MacSocketHash;
73 
74 typedef void (*MaybeCancelWaitForMoreEventsFn)(QAbstractEventDispatcher *hostEventDispacher);
75 
76 // The CoreFoundationSocketNotifier class implements socket notifiers support using
77 // CFSocket for event dispatchers running on top of the Core Foundation run loop system.
78 // (currently Mac and iOS)
79 //
80 // The principal functions are registerSocketNotifier() and unregisterSocketNotifier().
81 //
82 // setHostEventDispatcher() should be called at startup.
83 // removeSocketNotifiers() should be called at shutdown.
84 //
85 class Q_CORE_EXPORT QCFSocketNotifier
86 {
87 public:
88     QCFSocketNotifier();
89     ~QCFSocketNotifier();
90     void setHostEventDispatcher(QAbstractEventDispatcher *hostEventDispacher);
91     void setMaybeCancelWaitForMoreEventsCallback(MaybeCancelWaitForMoreEventsFn callBack);
92     void registerSocketNotifier(QSocketNotifier *notifier);
93     void unregisterSocketNotifier(QSocketNotifier *notifier);
94     void removeSocketNotifiers();
95 
96 private:
97     void destroyRunLoopObserver();
98 
99     static void unregisterSocketInfo(MacSocketInfo *socketInfo);
100     static void enableSocketNotifiers(CFRunLoopObserverRef ref, CFRunLoopActivity activity, void *info);
101 
102     MacSocketHash macSockets;
103     QAbstractEventDispatcher *eventDispatcher;
104     MaybeCancelWaitForMoreEventsFn maybeCancelWaitForMoreEvents;
105     CFRunLoopObserverRef enableNotifiersObserver;
106 
107     friend void qt_mac_socket_callback(CFSocketRef, CFSocketCallBackType, CFDataRef, const void *, void *);
108 };
109 
110 QT_END_NAMESPACE
111 
112 #endif
113