mirror of
https://github.com/Retropex/dolphin.git
synced 2025-05-27 20:42:32 +02:00
258 lines
8.6 KiB
C++
258 lines
8.6 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2016 The Qt Company Ltd.
|
|
** Contact: https://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtNetwork module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see https://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at https://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 3 as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.LGPL3 included in the
|
|
** packaging of this file. Please review the following information to
|
|
** ensure the GNU Lesser General Public License version 3 requirements
|
|
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
|
|
**
|
|
** GNU General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU
|
|
** General Public License version 2.0 or (at your option) the GNU General
|
|
** Public license version 3 or any later version approved by the KDE Free
|
|
** Qt Foundation. The licenses are as published by the Free Software
|
|
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
|
|
** included in the packaging of this file. Please review the following
|
|
** information to ensure the GNU General Public License requirements will
|
|
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
|
|
** https://www.gnu.org/licenses/gpl-3.0.html.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef QABSTRACTSOCKET_H
|
|
#define QABSTRACTSOCKET_H
|
|
|
|
#include <QtNetwork/qtnetworkglobal.h>
|
|
#include <QtCore/qiodevice.h>
|
|
#include <QtCore/qobject.h>
|
|
#ifndef QT_NO_DEBUG_STREAM
|
|
#include <QtCore/qdebug.h>
|
|
#endif
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
|
|
class QHostAddress;
|
|
#ifndef QT_NO_NETWORKPROXY
|
|
class QNetworkProxy;
|
|
#endif
|
|
class QAbstractSocketPrivate;
|
|
class QAuthenticator;
|
|
|
|
class Q_NETWORK_EXPORT QAbstractSocket : public QIODevice
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
enum SocketType {
|
|
TcpSocket,
|
|
UdpSocket,
|
|
SctpSocket,
|
|
UnknownSocketType = -1
|
|
};
|
|
Q_ENUM(SocketType)
|
|
enum NetworkLayerProtocol {
|
|
IPv4Protocol,
|
|
IPv6Protocol,
|
|
AnyIPProtocol,
|
|
UnknownNetworkLayerProtocol = -1
|
|
};
|
|
Q_ENUM(NetworkLayerProtocol)
|
|
enum SocketError {
|
|
ConnectionRefusedError,
|
|
RemoteHostClosedError,
|
|
HostNotFoundError,
|
|
SocketAccessError,
|
|
SocketResourceError,
|
|
SocketTimeoutError, /* 5 */
|
|
DatagramTooLargeError,
|
|
NetworkError,
|
|
AddressInUseError,
|
|
SocketAddressNotAvailableError,
|
|
UnsupportedSocketOperationError, /* 10 */
|
|
UnfinishedSocketOperationError,
|
|
ProxyAuthenticationRequiredError,
|
|
SslHandshakeFailedError,
|
|
ProxyConnectionRefusedError,
|
|
ProxyConnectionClosedError, /* 15 */
|
|
ProxyConnectionTimeoutError,
|
|
ProxyNotFoundError,
|
|
ProxyProtocolError,
|
|
OperationError,
|
|
SslInternalError, /* 20 */
|
|
SslInvalidUserDataError,
|
|
TemporaryError,
|
|
|
|
UnknownSocketError = -1
|
|
};
|
|
Q_ENUM(SocketError)
|
|
enum SocketState {
|
|
UnconnectedState,
|
|
HostLookupState,
|
|
ConnectingState,
|
|
ConnectedState,
|
|
BoundState,
|
|
ListeningState,
|
|
ClosingState
|
|
};
|
|
Q_ENUM(SocketState)
|
|
enum SocketOption {
|
|
LowDelayOption, // TCP_NODELAY
|
|
KeepAliveOption, // SO_KEEPALIVE
|
|
MulticastTtlOption, // IP_MULTICAST_TTL
|
|
MulticastLoopbackOption, // IP_MULTICAST_LOOPBACK
|
|
TypeOfServiceOption, //IP_TOS
|
|
SendBufferSizeSocketOption, //SO_SNDBUF
|
|
ReceiveBufferSizeSocketOption, //SO_RCVBUF
|
|
PathMtuSocketOption // IP_MTU
|
|
};
|
|
Q_ENUM(SocketOption)
|
|
enum BindFlag {
|
|
DefaultForPlatform = 0x0,
|
|
ShareAddress = 0x1,
|
|
DontShareAddress = 0x2,
|
|
ReuseAddressHint = 0x4
|
|
};
|
|
Q_DECLARE_FLAGS(BindMode, BindFlag)
|
|
enum PauseMode {
|
|
PauseNever = 0x0,
|
|
PauseOnSslErrors = 0x1
|
|
};
|
|
Q_DECLARE_FLAGS(PauseModes, PauseMode)
|
|
|
|
QAbstractSocket(SocketType socketType, QObject *parent);
|
|
virtual ~QAbstractSocket();
|
|
|
|
virtual void resume(); // to continue after proxy authentication required, SSL errors etc.
|
|
PauseModes pauseMode() const;
|
|
void setPauseMode(PauseModes pauseMode);
|
|
|
|
// ### Qt6: make the first one virtual
|
|
bool bind(const QHostAddress &address, quint16 port = 0, BindMode mode = DefaultForPlatform);
|
|
bool bind(quint16 port = 0, BindMode mode = DefaultForPlatform);
|
|
|
|
// ### Qt6: de-virtualize connectToHost(QHostAddress) overload
|
|
virtual void connectToHost(const QString &hostName, quint16 port, OpenMode mode = ReadWrite, NetworkLayerProtocol protocol = AnyIPProtocol);
|
|
virtual void connectToHost(const QHostAddress &address, quint16 port, OpenMode mode = ReadWrite);
|
|
virtual void disconnectFromHost();
|
|
|
|
bool isValid() const;
|
|
|
|
qint64 bytesAvailable() const override;
|
|
qint64 bytesToWrite() const override;
|
|
|
|
bool canReadLine() const override; // ### Qt6: remove me
|
|
|
|
quint16 localPort() const;
|
|
QHostAddress localAddress() const;
|
|
quint16 peerPort() const;
|
|
QHostAddress peerAddress() const;
|
|
QString peerName() const;
|
|
|
|
qint64 readBufferSize() const;
|
|
virtual void setReadBufferSize(qint64 size);
|
|
|
|
void abort();
|
|
|
|
virtual qintptr socketDescriptor() const;
|
|
virtual bool setSocketDescriptor(qintptr socketDescriptor, SocketState state = ConnectedState,
|
|
OpenMode openMode = ReadWrite);
|
|
|
|
virtual void setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value);
|
|
virtual QVariant socketOption(QAbstractSocket::SocketOption option);
|
|
|
|
SocketType socketType() const;
|
|
SocketState state() const;
|
|
SocketError error() const;
|
|
|
|
// from QIODevice
|
|
void close() override;
|
|
bool isSequential() const override;
|
|
bool atEnd() const override; // ### Qt6: remove me
|
|
bool flush();
|
|
|
|
// for synchronous access
|
|
virtual bool waitForConnected(int msecs = 30000);
|
|
bool waitForReadyRead(int msecs = 30000) override;
|
|
bool waitForBytesWritten(int msecs = 30000) override;
|
|
virtual bool waitForDisconnected(int msecs = 30000);
|
|
|
|
#ifndef QT_NO_NETWORKPROXY
|
|
void setProxy(const QNetworkProxy &networkProxy);
|
|
QNetworkProxy proxy() const;
|
|
QString protocolTag() const;
|
|
void setProtocolTag(const QString &tag);
|
|
#endif
|
|
|
|
Q_SIGNALS:
|
|
void hostFound();
|
|
void connected();
|
|
void disconnected();
|
|
void stateChanged(QAbstractSocket::SocketState);
|
|
#if QT_DEPRECATED_SINCE(5,15)
|
|
QT_DEPRECATED_NETWORK_API_5_15_X("Use QAbstractSocket::errorOccurred(QAbstractSocket::SocketError) instead")
|
|
void error(QAbstractSocket::SocketError);
|
|
#endif
|
|
void errorOccurred(QAbstractSocket::SocketError);
|
|
#ifndef QT_NO_NETWORKPROXY
|
|
void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator);
|
|
#endif
|
|
|
|
protected:
|
|
qint64 readData(char *data, qint64 maxlen) override;
|
|
qint64 readLineData(char *data, qint64 maxlen) override;
|
|
qint64 writeData(const char *data, qint64 len) override;
|
|
|
|
void setSocketState(SocketState state);
|
|
void setSocketError(SocketError socketError);
|
|
void setLocalPort(quint16 port);
|
|
void setLocalAddress(const QHostAddress &address);
|
|
void setPeerPort(quint16 port);
|
|
void setPeerAddress(const QHostAddress &address);
|
|
void setPeerName(const QString &name);
|
|
|
|
QAbstractSocket(SocketType socketType, QAbstractSocketPrivate &dd, QObject *parent = nullptr);
|
|
|
|
private:
|
|
Q_DECLARE_PRIVATE(QAbstractSocket)
|
|
Q_DISABLE_COPY(QAbstractSocket)
|
|
|
|
Q_PRIVATE_SLOT(d_func(), void _q_connectToNextAddress())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_startConnecting(const QHostInfo &))
|
|
Q_PRIVATE_SLOT(d_func(), void _q_abortConnectionAttempt())
|
|
Q_PRIVATE_SLOT(d_func(), void _q_testConnection())
|
|
};
|
|
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(QAbstractSocket::BindMode)
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(QAbstractSocket::PauseModes)
|
|
|
|
#ifndef QT_NO_DEBUG_STREAM
|
|
Q_NETWORK_EXPORT QDebug operator<<(QDebug, QAbstractSocket::SocketError);
|
|
Q_NETWORK_EXPORT QDebug operator<<(QDebug, QAbstractSocket::SocketState);
|
|
#endif
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
Q_DECLARE_METATYPE(QAbstractSocket::SocketState)
|
|
Q_DECLARE_METATYPE(QAbstractSocket::SocketError)
|
|
|
|
#endif // QABSTRACTSOCKET_H
|