summaryrefslogtreecommitdiff
path: root/src/qwebsocket_p.h
blob: d49788ddd5aead8f84cb825ddc778ad26af1909a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/**
 * @file websocket.h
 * @brief Defines the WebSocket class.
 *
 * \note Currently, only V13 (RFC6455) is supported.
 * \note Both text and binary websockets are supported.
 * \note The secure version (wss) is currently not implemented.
 * @author Kurt Pattyn (pattyn.kurt@gmail.com)
 */

#ifndef QWEBSOCKET_P_H
#define QWEBSOCKET_P_H
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QUrl>
#include <QAbstractSocket>
#include <QHostAddress>
#ifndef QT_NO_NETWORKPROXY
#include <QNetworkProxy>
#endif
#include <QTime>
#include "qwebsocketsglobal.h"
#include "qwebsocketprotocol.h"
#include "dataprocessor_p.h"

QT_BEGIN_NAMESPACE

class HandshakeRequest;
class HandshakeResponse;
class QTcpSocket;
class QWebSocket;

class QWebSocketPrivate:public QObject
{
	Q_OBJECT

public:
	explicit QWebSocketPrivate(QString origin,
							   QWebSocketProtocol::Version version,
							   QWebSocket * const pWebSocket,
							   QObject *parent = 0);
	virtual ~QWebSocketPrivate();

	void abort();
	QAbstractSocket::SocketError error() const;
	QString errorString() const;
	bool flush();
	bool isValid();
	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 resume();
	void setPauseMode(QAbstractSocket::PauseModes pauseMode);
	void setReadBufferSize(qint64 size);
	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();
	QString resourceName();
	QUrl requestUrl();
	QString origin();
	QString protocol();
	QString extension();

	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:
	virtual void close(QWebSocketProtocol::CloseCode closeCode = QWebSocketProtocol::CC_NORMAL, QString reason = QString());
	virtual void open(const QUrl &url, bool mask = true);
	void ping();

private Q_SLOTS:
	void processData();
	void processControlFrame(QWebSocketProtocol::OpCode opCode, QByteArray frame);
	void processHandshake(QTcpSocket *pSocket);
	void processStateChanged(QAbstractSocket::SocketState socketState);

private:
	Q_DISABLE_COPY(QWebSocketPrivate)

	QWebSocket * const q_ptr;

	QWebSocketPrivate(QTcpSocket *pTcpSocket, QWebSocketProtocol::Version version, QWebSocket *pWebSocket, QObject *parent = 0);
	void setVersion(QWebSocketProtocol::Version version);
	void setResourceName(QString resourceName);
	void setRequestUrl(QUrl requestUrl);
	void setOrigin(QString origin);
	void setProtocol(QString protocol);
	void setExtension(QString extension);
	void enableMasking(bool enable);
	void setSocketState(QAbstractSocket::SocketState state);
	void setErrorString(QString errorString);

	qint64 doWriteData(const QByteArray &data, bool isBinary);
	qint64 doWriteFrames(const QByteArray &data, bool isBinary);

	void makeConnections(const QTcpSocket *pTcpSocket);
	void releaseConnections(const QTcpSocket *pTcpSocket);

	QByteArray getFrameHeader(QWebSocketProtocol::OpCode opCode, quint64 payloadLength, quint32 maskingKey, bool lastFrame) const;
	QString calculateAcceptKey(const QString &key) const;
	QString createHandShakeRequest(QString resourceName,
								   QString host,
								   QString origin,
								   QString extensions,
								   QString protocols,
								   QByteArray key);

	static QWebSocket *upgradeFrom(QTcpSocket *tcpSocket,
								   const HandshakeRequest &request,
								   const HandshakeResponse &response,
								   QObject *parent = 0);

	quint32 generateMaskingKey() const;
	QByteArray generateKey() const;
	quint32 generateRandomNumber() const;
	qint64 writeFrames(const QList<QByteArray> &frames);
	qint64 writeFrame(const QByteArray &frame);

	QTcpSocket *m_pSocket;
	QString m_errorString;
	QWebSocketProtocol::Version m_version;
	QUrl m_resource;
	QString m_resourceName;
	QUrl m_requestUrl;
	QString m_origin;
	QString m_protocol;
	QString m_extension;
	QAbstractSocket::SocketState m_socketState;

	QByteArray m_key;	//identification key used in handshake requests

	bool m_mustMask;	//a server must not mask the frames it sends

	bool m_isClosingHandshakeSent;
	bool m_isClosingHandshakeReceived;

	QTime m_pingTimer;

	DataProcessor m_dataProcessor;


	friend class QWebSocketServerPrivate;
	friend class QWebSocket;
};

QT_END_NAMESPACE

#endif // QWEBSOCKET_H