- "WebSocket" is one word, with uppercase 'W' and 'S'.
- "HTTP"/"HTTPS" is fully uppercase
Change-Id: Ice3a50c94394433c97f7347291af5cda69b234ce
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
\example echoclient
\title Echo Client Example
\ingroup qtwebsockets-examples
- \brief Describes how to use the websocket API for creating a simple echo client.
+ \brief Describes how to use the WebSocket API for creating a simple echo client.
- The Echo Client Example shows how to use the websocket API to create a simple
+ The Echo Client Example shows how to use the WebSocket API to create a simple
echo client.
\sa {Echo Server Example}
sends back the messages it receives.
The Echo Server Example shows how to create a simple server application that
- sends back the messages it receives, using the websockets API.
+ sends back the messages it receives, using the WebSocket API.
\sa {Echo Client Example}
*/
\title Simple Chat Example
\ingroup qtwebsockets-examples
\brief Shows how to use the QWebSocket and QWebSocketServer classes
- for creating a minimalistic chat application over websockets.
+ for creating a minimalistic chat application over the WebSocket protocol.
The Simple Chat Example shows how to use the QWebSocket and QWebSocketServer
- classes to create a minimalistic chat application over websockets.
+ classes to create a minimalistic chat application over the WebSocket protocol.
*/
//! [onConnected]
void EchoClient::onConnected()
{
- qDebug() << "Websocket connected";
+ qDebug() << "WebSocket connected";
connect(&m_webSocket, &QWebSocket::textMessageReceived,
this, &EchoClient::onTextMessageReceived);
m_webSocket.sendTextMessage(QStringLiteral("Hello, world!"));
<html>
<head>
- <title>Websocket Echo Client</title>
+ <title>WebSocket Echo Client</title>
</head>
<body>
- <h1>Websocket Echo Client</h1>
+ <h1>WebSocket Echo Client</h1>
<p>
- <button onClick="initWebsocket();">Connect</button>
- <button onClick="stopWebsocket();">Disconnect</button>
+ <button onClick="initWebSocket();">Connect</button>
+ <button onClick="stopWebSocket();">Disconnect</button>
<button onClick="checkSocket();">State</button>
</p>
<p>
var wsUri = "ws://localhost:1234";
var websocket = null;
- function initWebsocket() {
+ function initWebSocket() {
try {
if (typeof MozWebSocket == 'function')
WebSocket = MozWebSocket;
}
}
- function stopWebsocket() {
+ function stopWebSocket() {
if (websocket)
websocket.close();
}
break;
}
}
- debug("Websocket state = " + websocket.readyState + " ( " + stateStr + " )");
+ debug("WebSocket state = " + websocket.readyState + " ( " + stateStr + " )");
} else {
- debug("Websocket is null");
+ debug("WebSocket is null");
}
}
</script>
<html>
<head>
- <title>Websocket Chat Client</title>
+ <title>WebSocket Chat Client</title>
</head>
<body>
- <h1>Websocket Chat Client</h1>
+ <h1>WebSocket Chat Client</h1>
<p>
- <button onClick="initWebsocket();">Connect</button>
- <button onClick="stopWebsocket();">Disconnect</button>
+ <button onClick="initWebSocket();">Connect</button>
+ <button onClick="stopWebSocket();">Disconnect</button>
<button onClick="checkSocket();">State</button>
</p>
<p>
var wsUri = "ws://localhost:1234";
var websocket = null;
- function initWebsocket() {
+ function initWebSocket() {
try {
if (typeof MozWebSocket == 'function')
WebSocket = MozWebSocket;
}
}
- function stopWebsocket() {
+ function stopWebSocket() {
if (websocket)
websocket.close();
}
break;
}
}
- debug("Websocket state = " + websocket.readyState + " ( " + stateStr + " )");
+ debug("WebSocket state = " + websocket.readyState + " ( " + stateStr + " )");
} else {
- debug("Websocket is null");
+ debug("WebSocket is null");
}
}
</script>
//! [onConnected]
void SslEchoClient::onConnected()
{
- qDebug() << "Websocket connected";
+ qDebug() << "WebSocket connected";
connect(&m_webSocket, &QWebSocket::textMessageReceived,
this, &SslEchoClient::onTextMessageReceived);
m_webSocket.sendTextMessage(QStringLiteral("Hello, world!"));
<!DOCTYPE html>
<html>
<head>
- <title>Websocket Echo Client</title>
+ <title>WebSocket Echo Client</title>
<meta charset="utf-8">
</head>
<body>
- <h1>Websocket Echo Client</h1>
+ <h1>WebSocket Echo Client</h1>
<p>
- <button onClick="initWebsocket();">Connect</button>
- <button onClick="stopWebsocket();">Disconnect</button>
+ <button onClick="initWebSocket();">Connect</button>
+ <button onClick="stopWebSocket();">Disconnect</button>
<button onClick="checkSocket();">State</button>
</p>
<p>
}
}
- function initWebsocket() {
+ function initWebSocket() {
try {
if (typeof MozWebSocket == 'function')
WebSocket = MozWebSocket;
}
}
- function stopWebsocket() {
+ function stopWebSocket() {
if (websocket)
websocket.close();
}
break;
}
}
- debug("Websocket state = " + websocket.readyState + " ( " + stateStr + " )");
+ debug("WebSocket state = " + websocket.readyState + " ( " + stateStr + " )");
} else {
- debug("Websocket is null");
+ debug("WebSocket is null");
}
}
</script>
QT_BEGIN_NAMESPACE
-void QmlWebsocket_plugin::registerTypes(const char *uri)
+void QmlWebSocket_plugin::registerTypes(const char *uri)
{
Q_ASSERT(uri == QLatin1String("Qt.WebSockets"));
QT_BEGIN_NAMESPACE
-class QmlWebsocket_plugin : public QQmlExtensionPlugin
+class QmlWebSocket_plugin : public QQmlExtensionPlugin
{
Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
\class QWebSocket
\inmodule QtWebSockets
- \brief Implements a TCP socket that talks the websocket protocol.
+ \brief Implements a TCP socket that talks the WebSocket protocol.
WebSockets is a web technology providing full-duplex communications channels over
a single TCP connection.
QWebSocket only supports version 13 of the WebSocket protocol, as outlined in
\l {http://tools.ietf.org/html/rfc6455}{RFC 6455}.
- \note Some proxies do not understand certain HTTP headers used during a web socket handshake.
- In that case, non-secure web socket connections fail. The best way to mitigate against
- this problem is to use web sockets over a secure connection.
+ \note Some proxies do not understand certain HTTP headers used during a WebSocket handshake.
+ In that case, non-secure WebSocket connections fail. The best way to mitigate against
+ this problem is to use WebSocket over a secure connection.
\warning To generate masks, this implementation of WebSockets uses the cryptographically
insecure qrand() function.
/*!
\page echoclient.html example
\title QWebSocket client example
- \brief A sample websocket client that sends a message and displays the message that
+ \brief A sample WebSocket client that sends a message and displays the message that
it receives back.
\section1 Description
- The EchoClient example implements a web socket client that sends a message to a websocket server
+ The EchoClient example implements a WebSocket client that sends a message to a WebSocket server
and dumps the answer that it gets back.
This example should ideally be used with the EchoServer example.
\section1 Code
This signal is emitted every time a payload of data has been written to the socket.
The \a bytes argument is set to the number of bytes that were written in this payload.
- \note This signal has the same meaning both for secure and non-secure websockets.
+ \note This signal has the same meaning both for secure and non-secure WebSockets.
As opposed to QSslSocket, bytesWritten() is only emitted when encrypted data is effectively
written (see QSslSocket::encryptedBytesWritten()).
\sa close()
}
/*!
- \brief Opens a websocket connection using the given \a url.
+ \brief Opens a WebSocket connection using the given \a url.
If the url contains newline characters (\\r\\n), then the error signal will be emitted
with QAbstractSocket::ConnectionRefusedError as error type.
}
} else {
const QString message =
- QWebSocket::tr("Unsupported websockets scheme: %1").arg(url.scheme());
+ QWebSocket::tr("Unsupported WebSocket scheme: %1").arg(url.scheme());
setErrorString(message);
Q_EMIT q->error(QAbstractSocket::UnsupportedSocketOperationError);
}
/*!
\internal
- Sets the version to use for the websocket protocol;
+ Sets the version to use for the WebSocket protocol;
this must be set before the socket is opened.
*/
void QWebSocketPrivate::setVersion(QWebSocketProtocol::Version version)
/*!
\class QWebSocketDataProcessor
The class QWebSocketDataProcessor is responsible for reading, validating and
- interpreting data from a websocket.
+ interpreting data from a WebSocket.
It reads data from a QIODevice, validates it against RFC 6455, and parses it into
frames (data, control).
It emits signals that correspond to the type of the frame: textFrameReceived(),
/*!
\class QWebSocketFrame
The class QWebSocketFrame is responsible for reading, validating and
- interpreting frames from a websocket.
+ interpreting frames from a WebSocket.
It reads data from a QIODevice, validates it against RFC 6455, and parses it into a
frame (data, control).
Whenever an error is detected, isValid() returns false.
switch (processingState) {
case PS_WAIT_FOR_MORE_DATA:
//TODO: waitForReadyRead should really be changed
- //now, when a websocket is used in a GUI thread
+ //now, when a WebSocket is used in a GUI thread
//the GUI will hang for at most 5 seconds
//maybe, a QStateMachine should be used
if (!pIoDevice->waitForReadyRead(5000)) {
\inmodule QtWebSockets
- \brief The different defined versions of the Websocket protocol.
+ \brief The different defined versions of the WebSocket protocol.
For an overview of the differences between the different protocols, see
<http://code.google.com/p/pywebsocket/wiki/WebSocketProtocolSpec>
/*!
\fn QWebSocketProtocol::isCloseCodeValid(int closeCode)
- Checks if \a closeCode is a valid web socket close code
+ Checks if \a closeCode is a valid WebSocket close code
\internal
*/
\inmodule QtWebSockets
- \brief Implements a websocket-based server.
+ \brief Implements a WebSocket-based server.
It is modeled after QTcpServer, and behaves the same. So, if you know how to use QTcpServer,
you know how to use QWebSocketServer.
- This class makes it possible to accept incoming websocket connections.
+ This class makes it possible to accept incoming WebSocket connections.
You can specify the port or have QWebSocketServer pick one automatically.
You can listen on a specific address or on all the machine's addresses.
Call listen() to have the server listen for incoming connections.
\note When working with self-signed certificates, FireFox currently has a
\l {https://bugzilla.mozilla.org/show_bug.cgi?id=594502} {bug} that prevents it to
- connect to a secure websocket server. To work around this problem, first browse to the
- secure websocket server using https. FireFox will indicate that the certificate is invalid.
- From here on, the certificate can be added to the exceptions. After this, the secure websockets
+ connect to a secure WebSocket server. To work around this problem, first browse to the
+ secure WebSocket server using HTTPS. FireFox will indicate that the certificate is invalid.
+ From here on, the certificate can be added to the exceptions. After this, the secure WebSockets
connection should work.
QWebSocketServer only supports version 13 of the WebSocket protocol, as outlined in RFC 6455.
/*!
\page echoserver.html example
\title WebSocket server example
- \brief A sample websocket server echoing back messages sent to it.
+ \brief A sample WebSocket server echoing back messages sent to it.
\section1 Description
- The echoserver example implements a web socket server that echoes back everything that is sent
+ The echoserver example implements a WebSocket server that echoes back everything that is sent
to it.
\section1 Code
We start by creating a QWebSocketServer (`new QWebSocketServer()`). After the creation, we listen
\snippet echoserver/echoserver.cpp constructor
If listening is successful, we connect the `newConnection()` signal to the slot
`onNewConnection()`.
- The `newConnection()` signal will be thrown whenever a new web socket client is connected to our
+ The `newConnection()` signal will be thrown whenever a new WebSocket client is connected to our
server.
\snippet echoserver/echoserver.cpp onNewConnection
/*!
\fn void QWebSocketServer::serverError(QWebSocketProtocol::CloseCode closeCode)
- This signal is emitted when an error occurs during the setup of a web socket connection.
+ This signal is emitted when an error occurs during the setup of a WebSocket connection.
The \a closeCode parameter describes the type of error that occurred
\sa errorString()
QWebSocketServer will emit the error() signal with
the QWebSocketProtocol::CloseCodeAbnormalDisconnection close code
when the maximum of connections has been reached.
- The websocket handshake will fail and the socket will be closed.
+ The WebSocket handshake will fail and the socket will be closed.
\sa maxPendingConnections(), hasPendingConnections()
*/
}
/*!
- Returns a list of websocket versions that this server is supporting.
+ Returns a list of WebSocket versions that this server is supporting.
*/
QList<QWebSocketProtocol::Version> QWebSocketServer::supportedVersions() const
{
pTcpSocket->close();
pTcpSocket->deleteLater();
qWarning() << QWebSocketServer::tr("Too many pending connections: " \
- "New websocket connection not accepted.");
+ "New WebSocket connection not accepted.");
setError(QWebSocketProtocol::CloseCodeAbnormalDisconnection,
QWebSocketServer::tr("Too many pending connections."));
return;
//this test checks if there doesn't occur an out-of-bounds exception
QTest::newRow("Correctly formatted but invalid short fields") << QStringLiteral("V R P");
QTest::newRow("Invalid \\0 character in header") << QStringLiteral("V R\0 P");
- QTest::newRow("Invalid http version in header") << QStringLiteral("V R HTTP/invalid");
+ QTest::newRow("Invalid HTTP version in header") << QStringLiteral("V R HTTP/invalid");
QTest::newRow("Empty header field") << QStringLiteral("GET . HTTP/1.1\r\nHEADER: ");
QTest::newRow("All zeros") << QString::fromUtf8(QByteArray(10, char(0)));
QTest::newRow("Invalid hostname") << QStringLiteral("GET . HTTP/1.1\r\nHost: \xFF\xFF");
//doing extensive QStringLiteral concatenations here, because
//MSVC 2010 complains when using concatenation literal strings about
//concatenation of wide and narrow strings (error C2308)
- QTest::newRow("Complete header - Invalid websocket version")
+ QTest::newRow("Complete header - Invalid WebSocket version")
<< QStringLiteral("GET . HTTP/1.1\r\nHost: foo\r\nSec-WebSocket-Version: ") +
QStringLiteral("\xFF\xFF\r\n") +
QStringLiteral("Sec-WebSocket-Key: AVDFBDDFF\r\n") +
QStringLiteral("Sec-WebSocket-Key: AVDFBDDFF\r\n") +
QStringLiteral("Upgrade: websocket\r\n") +
QStringLiteral("Connection: Upgrade\r\n\r\n");
- QTest::newRow("Complete header - Invalid http version")
+ QTest::newRow("Complete header - Invalid HTTP version")
<< QStringLiteral("GET . HTTP/a.1\r\nHost: foo\r\nSec-WebSocket-Version: 13\r\n") +
QStringLiteral("Sec-WebSocket-Key: AVDFBDDFF\r\n") +
QStringLiteral("Upgrade: websocket\r\n") +
projects / contrib / qtwebsockets.git / commitdiff