diff options
author | Steven Ceuppens <steven.ceuppens@icloud.com> | 2013-09-27 14:27:27 +0200 |
---|---|---|
committer | Kurt Pattyn <pattyn.kurt@gmail.com> | 2013-09-28 21:17:48 +0200 |
commit | 6e1e387174d20fb62a804b6e27438bcc5ea59f28 (patch) | |
tree | 68d5c273ea682a244398ba8d3c7fbeb4a5f76b9b /src/websockets/qwebsocket.h | |
parent | 315e4fa0764f8d7a568be2a8063cc33c9ec13518 (diff) | |
download | qtwebsockets-6e1e387174d20fb62a804b6e27438bcc5ea59f28.tar.gz |
Changes to integrate the websocket module as a full Qt Add-On module
- Changed project files to use Qt structure
- Moved existing sources into subdirectory, to make room for moduels
- Created a "import/qmlwebsocket" module skeleton (works, but needs to be extended)
- Modified examples to not use "include(.pri)", but use "QT += websocket"
- Added qml example skeleton (works, but no useful functionality yet)
Project can be build with:
$ qmake
$ make
$ make install
Module can be used in other projects with
QT += websockets
Change-Id: I2123026958b264670dbf8a978dee76edf5855806
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocket.h')
-rw-r--r-- | src/websockets/qwebsocket.h | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/src/websockets/qwebsocket.h b/src/websockets/qwebsocket.h new file mode 100644 index 0000000..cffc87d --- /dev/null +++ b/src/websockets/qwebsocket.h @@ -0,0 +1,116 @@ +/* +QWebSockets implements the WebSocket protocol as defined in RFC 6455. +Copyright (C) 2013 Kurt Pattyn (pattyn.kurt@gmail.com) + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +*/ + +#ifndef QWEBSOCKET_H +#define QWEBSOCKET_H + +#include <QUrl> +#include <QAbstractSocket> +#include <QHostAddress> +#ifndef QT_NO_NETWORKPROXY +#include <QNetworkProxy> +#endif +#include <QTime> +#include "qwebsocketsglobal.h" +#include "qwebsocketprotocol.h" + +QT_BEGIN_NAMESPACE + +class QTcpSocket; +class QWebSocketPrivate; + +class Q_WEBSOCKETS_EXPORT QWebSocket:public QObject +{ + Q_OBJECT + +public: + explicit QWebSocket(const QString &origin = QString(), QWebSocketProtocol::Version version = QWebSocketProtocol::V_LATEST, QObject *parent = 0); + virtual ~QWebSocket(); + + void abort(); + QAbstractSocket::SocketError error() const; + QString errorString() const; + bool flush(); + bool isValid() const; + QHostAddress localAddress() const; + quint16 localPort() const; + QAbstractSocket::PauseModes pauseMode() const; + QHostAddress peerAddress() const; + QString peerName() const; + quint16 peerPort() const; +#ifndef QT_NO_NETWORKPROXY + QNetworkProxy proxy() const; + void setProxy(const QNetworkProxy &networkProxy); +#endif + qint64 readBufferSize() const; + void setReadBufferSize(qint64 size); + + void resume(); + void setPauseMode(QAbstractSocket::PauseModes pauseMode); + + void setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value); + QVariant socketOption(QAbstractSocket::SocketOption option); + QAbstractSocket::SocketState state() const; + + bool waitForConnected(int msecs = 30000); + bool waitForDisconnected(int msecs = 30000); + + QWebSocketProtocol::Version version() const; + QString resourceName() const; + QUrl requestUrl() const; + QString origin() const; + QString protocol() const; + QString extension() const; + + qint64 write(const char *message); //send data as text + qint64 write(const char *message, qint64 maxSize); //send data as text + qint64 write(const QString &message); //send data as text + qint64 write(const QByteArray &data); //send data as binary + +public Q_SLOTS: + void close(QWebSocketProtocol::CloseCode closeCode = QWebSocketProtocol::CC_NORMAL, const QString &reason = QString()); + void open(const QUrl &url, bool mask = true); + void ping(const QByteArray &payload = QByteArray()); + +Q_SIGNALS: + void aboutToClose(); + void connected(); + void disconnected(); + void stateChanged(QAbstractSocket::SocketState state); +#ifndef QT_NO_NETWORKPROXY + void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *pAuthenticator); +#endif + void readChannelFinished(); + void textFrameReceived(QString frame, bool isLastFrame); + void binaryFrameReceived(QByteArray frame, bool isLastFrame); + void textMessageReceived(QString message); + void binaryMessageReceived(QByteArray message); + void error(QAbstractSocket::SocketError error); + void pong(quint64 elapsedTime, QByteArray payload); + +private: + Q_DISABLE_COPY(QWebSocket) + Q_DECLARE_PRIVATE(QWebSocket) + QWebSocket(QTcpSocket *pTcpSocket, QWebSocketProtocol::Version version, QObject *parent = 0); + QWebSocketPrivate * const d_ptr; +}; + +QT_END_NAMESPACE + +#endif // QWEBSOCKET_H |