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 class QMaskGenerator;
  61
  62 class Q_WEBSOCKETS_EXPORT QWebSocket : public QObject
  63 {
  64     Q_OBJECT
  65     Q_DISABLE_COPY(QWebSocket)
  66     Q_DECLARE_PRIVATE(QWebSocket)
  67
  68 public:
  69     explicit QWebSocket(const QString &origin = QString(),
  70                         QWebSocketProtocol::Version version = QWebSocketProtocol::VersionLatest,
  71                         QObject *parent = Q_NULLPTR);
  72     virtual ~QWebSocket();
  73
  74     void abort();
  75     QAbstractSocket::SocketError error() const;
  76     QString errorString() const;
  77     bool flush();
  78     bool isValid() const;
  79     QHostAddress localAddress() const;
  80     quint16 localPort() const;
  81     QAbstractSocket::PauseModes pauseMode() const;
  82     QHostAddress peerAddress() const;
  83     QString peerName() const;
  84     quint16 peerPort() const;
  85 #ifndef QT_NO_NETWORKPROXY
  86     QNetworkProxy proxy() const;
  87     void setProxy(const QNetworkProxy &networkProxy);
  88 #endif
  89     void setMaskGenerator(const QMaskGenerator *maskGenerator);
  90     const QMaskGenerator *maskGenerator() const;
  91     qint64 readBufferSize() const;
  92     void setReadBufferSize(qint64 size);
  93
  94     void resume();
  95     void setPauseMode(QAbstractSocket::PauseModes pauseMode);
  96
  97     QAbstractSocket::SocketState state() const;
  98
  99     QWebSocketProtocol::Version version() const;
 100     QString resourceName() const;
 101     QUrl requestUrl() const;
 102     QString origin() const;
 103     QWebSocketProtocol::CloseCode closeCode() const;
 104     QString closeReason() const;
 105
 106     qint64 sendTextMessage(const QString &message);
 107     qint64 sendBinaryMessage(const QByteArray &data);
 108
 109 #ifndef QT_NO_SSL
 110     void ignoreSslErrors(const QList<QSslError> &errors);
 111     void setSslConfiguration(const QSslConfiguration &sslConfiguration);
 112     QSslConfiguration sslConfiguration() const;
 113 #endif
 114
 115 public Q_SLOTS:
 116     void close(QWebSocketProtocol::CloseCode closeCode = QWebSocketProtocol::CloseCodeNormal,
 117                const QString &reason = QString());
 118     void open(const QUrl &url);
 119     void ping(const QByteArray &payload = QByteArray());
 120 #ifndef QT_NO_SSL
 121     void ignoreSslErrors();
 122 #endif
 123
 124 Q_SIGNALS:
 125     void aboutToClose();
 126     void connected();
 127     void disconnected();
 128     void stateChanged(QAbstractSocket::SocketState state);
 129 #ifndef QT_NO_NETWORKPROXY
 130     void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *pAuthenticator);
 131 #endif
 132     void readChannelFinished();
 133     void textFrameReceived(const QString &frame, bool isLastFrame);
 134     void binaryFrameReceived(const QByteArray &frame, bool isLastFrame);
 135     void textMessageReceived(const QString &message);
 136     void binaryMessageReceived(const QByteArray &message);
 137     void error(QAbstractSocket::SocketError error);
 138     void pong(quint64 elapsedTime, const QByteArray &payload);
 139     void bytesWritten(qint64 bytes);
 140
 141 #ifndef QT_NO_SSL
 142     void sslErrors(const QList<QSslError> &errors);
 143 #endif
 144
 145 private:
 146     QWebSocket(QTcpSocket *pTcpSocket, QWebSocketProtocol::Version version,
 147                QObject *parent = Q_NULLPTR);
 148 };
 149
 150 QT_END_NAMESPACE
 151
 152 #endif // QWEBSOCKET_H