src/websockets/qwebsocket.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtWebSockets 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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QWEBSOCKET_H
  43 #define QWEBSOCKET_H
  44
  45 #include <QtCore/QUrl>
  46 #ifndef QT_NO_NETWORKPROXY
  47 #include <QtNetwork/QNetworkProxy>
  48 #endif
  49 #ifndef QT_NO_SSL
  50 #include <QtNetwork/QSslError>
  51 #include <QtNetwork/QSslConfiguration>
  52 #endif
  53 #include "QtWebSockets/qwebsockets_global.h"
  54 #include "QtWebSockets/qwebsocketprotocol.h"
  55
  56 QT_BEGIN_NAMESPACE
  57
  58 class QTcpSocket;
  59 class QWebSocketPrivate;
  60
  61 class Q_WEBSOCKETS_EXPORT QWebSocket : public QObject
  62 {
  63     Q_OBJECT
  64     Q_DISABLE_COPY(QWebSocket)
  65     Q_DECLARE_PRIVATE(QWebSocket)
  66
  67 public:
  68     explicit QWebSocket(const QString &origin = QString(),
  69                         QWebSocketProtocol::Version version = QWebSocketProtocol::VersionLatest,
  70                         QObject *parent = Q_NULLPTR);
  71     virtual ~QWebSocket();
  72
  73     void abort();
  74     QAbstractSocket::SocketError error() const;
  75     QString errorString() const;
  76     bool flush();
  77     bool isValid() const;
  78     QHostAddress localAddress() const;
  79     quint16 localPort() const;
  80     QAbstractSocket::PauseModes pauseMode() const;
  81     QHostAddress peerAddress() const;
  82     QString peerName() const;
  83     quint16 peerPort() const;
  84 #ifndef QT_NO_NETWORKPROXY
  85     QNetworkProxy proxy() const;
  86     void setProxy(const QNetworkProxy &networkProxy);
  87 #endif
  88     qint64 readBufferSize() const;
  89     void setReadBufferSize(qint64 size);
  90
  91     void resume();
  92     void setPauseMode(QAbstractSocket::PauseModes pauseMode);
  93
  94     QAbstractSocket::SocketState state() const;
  95
  96     QWebSocketProtocol::Version version() const;
  97     QString resourceName() const;
  98     QUrl requestUrl() const;
  99     QString origin() const;
 100     QWebSocketProtocol::CloseCode closeCode() const;
 101     QString closeReason() const;
 102
 103     qint64 sendTextMessage(const QString &message);
 104     qint64 sendBinaryMessage(const QByteArray &data);
 105
 106 #ifndef QT_NO_SSL
 107     void ignoreSslErrors(const QList<QSslError> &errors);
 108     void setSslConfiguration(const QSslConfiguration &sslConfiguration);
 109     QSslConfiguration sslConfiguration() const;
 110 #endif
 111
 112 public Q_SLOTS:
 113     void close(QWebSocketProtocol::CloseCode closeCode = QWebSocketProtocol::CloseCodeNormal,
 114                const QString &reason = QString());
 115     void open(const QUrl &url);
 116     void ping(const QByteArray &payload = QByteArray());
 117 #ifndef QT_NO_SSL
 118     void ignoreSslErrors();
 119 #endif
 120
 121 Q_SIGNALS:
 122     void aboutToClose();
 123     void connected();
 124     void disconnected();
 125     void stateChanged(QAbstractSocket::SocketState state);
 126 #ifndef QT_NO_NETWORKPROXY
 127     void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *pAuthenticator);
 128 #endif
 129     void readChannelFinished();
 130     void textFrameReceived(const QString &frame, bool isLastFrame);
 131     void binaryFrameReceived(const QByteArray &frame, bool isLastFrame);
 132     void textMessageReceived(const QString &message);
 133     void binaryMessageReceived(const QByteArray &message);
 134     void error(QAbstractSocket::SocketError error);
 135     void pong(quint64 elapsedTime, const QByteArray &payload);
 136     void bytesWritten(qint64 bytes);
 137
 138 #ifndef QT_NO_SSL
 139     void sslErrors(const QList<QSslError> &errors);
 140 #endif
 141
 142 private:
 143     QWebSocket(QTcpSocket *pTcpSocket, QWebSocketProtocol::Version version,
 144                QObject *parent = Q_NULLPTR);
 145 };
 146
 147 QT_END_NAMESPACE
 148
 149 #endif // QWEBSOCKET_H