1/****************************************************************************
2**
3** Copyright (C) 2022 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork 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 QABSTRACTSOCKET_P_H
41#define QABSTRACTSOCKET_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 for the convenience
48// of the QAbstractSocket class. This header file may change from
49// version to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtNetwork/private/qtnetworkglobal_p.h>
55#include "QtNetwork/qabstractsocket.h"
56#include "QtCore/qbytearray.h"
57#include "QtCore/qlist.h"
58#include "QtCore/qtimer.h"
59#include "private/qiodevice_p.h"
60#include "private/qabstractsocketengine_p.h"
61#include "qnetworkproxy.h"
62
63QT_BEGIN_NAMESPACE
64
65class QHostInfo;
66
67class QAbstractSocketPrivate : public QIODevicePrivate, public QAbstractSocketEngineReceiver
68{
69 Q_DECLARE_PUBLIC(QAbstractSocket)
70public:
71 QAbstractSocketPrivate();
72 virtual ~QAbstractSocketPrivate();
73
74 // from QIODevicePrivate
75 qint64 skip(qint64 maxSize) override;
76
77 // from QAbstractSocketEngineReceiver
78 inline void readNotification() override { canReadNotification(); }
79 inline void writeNotification() override { canWriteNotification(); }
80 inline void exceptionNotification() override {}
81 inline void closeNotification() override { canCloseNotification(); }
82 void connectionNotification() override;
83#ifndef QT_NO_NETWORKPROXY
84 inline void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator) override {
85 Q_Q(QAbstractSocket);
86 emit q->proxyAuthenticationRequired(proxy, authenticator);
87 }
88#endif
89
90 virtual bool bind(const QHostAddress &address, quint16 port, QAbstractSocket::BindMode mode);
91
92 virtual bool canReadNotification();
93 bool canWriteNotification();
94 void canCloseNotification();
95
96 // slots
97 void _q_connectToNextAddress();
98 void _q_startConnecting(const QHostInfo &hostInfo);
99 void _q_testConnection();
100 void _q_abortConnectionAttempt();
101
102 bool emittedReadyRead;
103 bool emittedBytesWritten;
104
105 bool abortCalled;
106 bool pendingClose;
107
108 QAbstractSocket::PauseModes pauseMode;
109
110 QString hostName;
111 quint16 port;
112 QHostAddress host;
113 QList<QHostAddress> addresses;
114
115 quint16 localPort;
116 quint16 peerPort;
117 QHostAddress localAddress;
118 QHostAddress peerAddress;
119 QString peerName;
120
121 QAbstractSocketEngine *socketEngine;
122 qintptr cachedSocketDescriptor;
123
124#ifndef QT_NO_NETWORKPROXY
125 QNetworkProxy proxy;
126 QNetworkProxy proxyInUse;
127 QString protocolTag;
128 void resolveProxy(const QString &hostName, quint16 port);
129#else
130 inline void resolveProxy(const QString &, quint16) { }
131#endif
132 inline void resolveProxy(quint16 port) { resolveProxy(hostName: QString(), port); }
133
134 void resetSocketLayer();
135 virtual bool flush();
136
137 bool initSocketLayer(QAbstractSocket::NetworkLayerProtocol protocol);
138 virtual void configureCreatedSocket();
139 void startConnectingByName(const QString &host);
140 void fetchConnectionParameters();
141 bool readFromSocket();
142 virtual bool writeToSocket();
143 void emitReadyRead(int channel = 0);
144 void emitBytesWritten(qint64 bytes, int channel = 0);
145
146 void setError(QAbstractSocket::SocketError errorCode, const QString &errorString);
147 void setErrorAndEmit(QAbstractSocket::SocketError errorCode, const QString &errorString);
148
149 qint64 readBufferMaxSize;
150 bool isBuffered;
151 bool hasPendingData;
152
153 QTimer *connectTimer;
154
155 int hostLookupId;
156
157 QAbstractSocket::SocketType socketType;
158 QAbstractSocket::SocketState state;
159
160 // Must be kept in sync with QIODevicePrivate::errorString.
161 QAbstractSocket::SocketError socketError;
162
163 QAbstractSocket::NetworkLayerProtocol preferredNetworkLayerProtocol;
164
165 bool prePauseReadSocketNotifierState = false;
166 bool prePauseWriteSocketNotifierState = false;
167 bool prePauseExceptionSocketNotifierState = false;
168 static void pauseSocketNotifiers(QAbstractSocket*);
169 static void resumeSocketNotifiers(QAbstractSocket*);
170 static QAbstractSocketEngine* getSocketEngine(QAbstractSocket*);
171};
172
173QT_END_NAMESPACE
174
175#endif // QABSTRACTSOCKET_P_H
176

source code of qtbase/src/network/socket/qabstractsocket_p.h