| /**************************************************************************** |
| ** |
| ** Copyright (C) 2015 The Qt Company Ltd. |
| ** Contact: http://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtNetwork module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL21$ |
| ** 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 http://www.qt.io/terms-conditions. For further |
| ** information use the contact form at http://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 2.1 or version 3 as published by the Free |
| ** Software Foundation and appearing in the file LICENSE.LGPLv21 and |
| ** LICENSE.LGPLv3 included in the packaging of this file. Please review the |
| ** following information to ensure the GNU Lesser General Public License |
| ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and |
| ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
| ** |
| ** As a special exception, The Qt Company gives you certain additional |
| ** rights. These rights are described in The Qt Company LGPL Exception |
| ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #ifndef QABSTRACTSOCKET_H |
| #define QABSTRACTSOCKET_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, |
| 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 |
| }; |
| 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 Q_DECL_OVERRIDE; |
| qint64 bytesToWrite() const Q_DECL_OVERRIDE; |
| |
| bool canReadLine() const Q_DECL_OVERRIDE; |
| |
| 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() Q_DECL_OVERRIDE; |
| bool isSequential() const Q_DECL_OVERRIDE; |
| bool atEnd() const Q_DECL_OVERRIDE; |
| bool flush(); |
| |
| // for synchronous access |
| virtual bool waitForConnected(int msecs = 30000); |
| bool waitForReadyRead(int msecs = 30000) Q_DECL_OVERRIDE; |
| bool waitForBytesWritten(int msecs = 30000) Q_DECL_OVERRIDE; |
| virtual bool waitForDisconnected(int msecs = 30000); |
| |
| #ifndef QT_NO_NETWORKPROXY |
| void setProxy(const QNetworkProxy &networkProxy); |
| QNetworkProxy proxy() const; |
| #endif |
| |
| Q_SIGNALS: |
| void hostFound(); |
| void connected(); |
| void disconnected(); |
| void stateChanged(QAbstractSocket::SocketState); |
| void error(QAbstractSocket::SocketError); |
| #ifndef QT_NO_NETWORKPROXY |
| void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *authenticator); |
| #endif |
| |
| protected: |
| qint64 readData(char *data, qint64 maxlen) Q_DECL_OVERRIDE; |
| qint64 readLineData(char *data, qint64 maxlen) Q_DECL_OVERRIDE; |
| qint64 writeData(const char *data, qint64 len) Q_DECL_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 = 0); |
| |
| 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_PRIVATE_SLOT(d_func(), void _q_forceDisconnect()) |
| }; |
| |
| |
| 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 |