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 QWINDOWSPIPEWRITER_P_H
41 #define QWINDOWSPIPEWRITER_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 <qelapsedtimer.h>
56 #include <qobject.h>
57 #include <qbytearray.h>
58 #include <qt_windows.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 #define SLEEPMIN 10
63 #define SLEEPMAX 500
64 
65 class QIncrementalSleepTimer
66 {
67 
68 public:
QIncrementalSleepTimer(int msecs)69     QIncrementalSleepTimer(int msecs)
70         : totalTimeOut(msecs)
71         , nextSleep(qMin(SLEEPMIN, totalTimeOut))
72     {
73         if (totalTimeOut == -1)
74             nextSleep = SLEEPMIN;
75         timer.start();
76     }
77 
nextSleepTime()78     int nextSleepTime()
79     {
80         int tmp = nextSleep;
81         nextSleep = qMin(nextSleep * 2, qMin(SLEEPMAX, timeLeft()));
82         return tmp;
83     }
84 
timeLeft()85     int timeLeft() const
86     {
87         if (totalTimeOut == -1)
88             return SLEEPMAX;
89         return qMax(int(totalTimeOut - timer.elapsed()), 0);
90     }
91 
hasTimedOut()92     bool hasTimedOut() const
93     {
94         if (totalTimeOut == -1)
95             return false;
96         return timer.elapsed() >= totalTimeOut;
97     }
98 
resetIncrements()99     void resetIncrements()
100     {
101         nextSleep = qMin(SLEEPMIN, timeLeft());
102     }
103 
104 private:
105     QElapsedTimer timer;
106     int totalTimeOut;
107     int nextSleep;
108 };
109 
110 class Q_CORE_EXPORT QWindowsPipeWriter : public QObject
111 {
112     Q_OBJECT
113 public:
114     explicit QWindowsPipeWriter(HANDLE pipeWriteEnd, QObject *parent = 0);
115     ~QWindowsPipeWriter();
116 
117     bool write(const QByteArray &ba);
118     void stop();
119     bool waitForWrite(int msecs);
isWriteOperationActive()120     bool isWriteOperationActive() const { return writeSequenceStarted; }
121     qint64 bytesToWrite() const;
122 
123 Q_SIGNALS:
124     void canWrite();
125     void bytesWritten(qint64 bytes);
126     void _q_queueBytesWritten(QPrivateSignal);
127 
128 private:
129     static void CALLBACK writeFileCompleted(DWORD errorCode, DWORD numberOfBytesTransfered,
130                                             OVERLAPPED *overlappedBase);
131     void notified(DWORD errorCode, DWORD numberOfBytesWritten);
132     bool waitForNotification(int timeout);
133     void emitPendingBytesWrittenValue();
134 
135     class Overlapped : public OVERLAPPED
136     {
137         Q_DISABLE_COPY_MOVE(Overlapped)
138     public:
139         explicit Overlapped(QWindowsPipeWriter *pipeWriter);
140         void clear();
141 
142         QWindowsPipeWriter *pipeWriter;
143     };
144 
145     HANDLE handle;
146     Overlapped overlapped;
147     QByteArray buffer;
148     qint64 pendingBytesWrittenValue;
149     bool stopped;
150     bool writeSequenceStarted;
151     bool notifiedCalled;
152     bool bytesWrittenPending;
153     bool inBytesWritten;
154 };
155 
156 QT_END_NAMESPACE
157 
158 #endif // QWINDOWSPIPEWRITER_P_H
159