1 /****************************************************************************
3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtWebSockets module of the Qt Toolkit.
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.
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.
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.
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.
40 ****************************************************************************/
43 \class QWebSocketServer
45 \inmodule QtWebSockets
47 \brief Implements a websocket-based server.
49 It is modeled after QTcpServer, and behaves the same. So, if you know how to use QTcpServer,
50 you know how to use QWebSocketServer.
51 This class makes it possible to accept incoming websocket connections.
52 You can specify the port or have QWebSocketServer pick one automatically.
53 You can listen on a specific address or on all the machine's addresses.
54 Call listen() to have the server listen for incoming connections.
56 The newConnection() signal is then emitted each time a client connects to the server.
57 Call nextPendingConnection() to accept the pending connection as a connected QWebSocket.
58 The function returns a pointer to a QWebSocket in QAbstractSocket::ConnectedState that you can
59 use for communicating with the client.
61 If an error occurs, serverError() returns the type of error, and errorString() can be called
62 to get a human readable description of what happened.
64 When listening for connections, the address and port on which the server is listening are
65 available as serverAddress() and serverPort().
67 Calling close() makes QWebSocketServer stop listening for incoming connections.
69 QWebSocketServer currently does not support
70 \l {http://tools.ietf.org/html/rfc6455#page-39} {extensions} and
71 \l {http://tools.ietf.org/html/rfc6455#page-12} {subprotocols}.
73 \note When working with self-signed certificates, FireFox currently has a
74 \l {https://bugzilla.mozilla.org/show_bug.cgi?id=594502} {bug} that prevents it to
75 connect to a secure websocket server. To work around this problem, first browse to the
76 secure websocket server using https. FireFox will indicate that the certificate is invalid.
77 From here on, the certificate can be added to the exceptions. After this, the secure websockets
78 connection should work.
80 QWebSocketServer only supports version 13 of the WebSocket protocol, as outlined in RFC 6455.
88 \page echoserver.html example
89 \title WebSocket server example
90 \brief A sample websocket server echoing back messages sent to it.
93 The echoserver example implements a web socket server that echoes back everything that is sent
96 We start by creating a QWebSocketServer (`new QWebSocketServer()`). After the creation, we listen
97 on all local network interfaces (`QHostAddress::Any`) on the specified \a port.
98 \snippet echoserver/echoserver.cpp constructor
99 If listening is successful, we connect the `newConnection()` signal to the slot
101 The `newConnection()` signal will be thrown whenever a new web socket client is connected to our
104 \snippet echoserver/echoserver.cpp onNewConnection
105 When a new connection is received, the client QWebSocket is retrieved (`nextPendingConnection()`),
106 and the signals we are interested in are connected to our slots
107 (`textMessageReceived()`, `binaryMessageReceived()` and `disconnected()`).
108 The client socket is remembered in a list, in case we would like to use it later
109 (in this example, nothing is done with it).
111 \snippet echoserver/echoserver.cpp processTextMessage
112 Whenever `processTextMessage()` is triggered, we retrieve the sender, and if valid, send back the
113 original message (`sendTextMessage()`).
114 The same is done with binary messages.
115 \snippet echoserver/echoserver.cpp processBinaryMessage
116 The only difference is that the message now is a QByteArray instead of a QString.
118 \snippet echoserver/echoserver.cpp socketDisconnected
119 Whenever a socket is disconnected, we remove it from the clients list and delete the socket.
120 Note: it is best to use `deleteLater()` to delete the socket.
124 \fn void QWebSocketServer::acceptError(QAbstractSocket::SocketError socketError)
125 This signal is emitted when accepting a new connection results in an error.
126 The \a socketError parameter describes the type of error that occurred
128 \sa pauseAccepting(), resumeAccepting()
132 \fn void QWebSocketServer::serverError(QWebSocketProtocol::CloseCode closeCode)
133 This signal is emitted when an error occurs during the setup of a web socket connection.
134 The \a closeCode parameter describes the type of error that occurred
140 \fn void QWebSocketServer::newConnection()
141 This signal is emitted every time a new connection is available.
143 \sa hasPendingConnections(), nextPendingConnection()
147 \fn void QWebSocketServer::closed()
148 This signal is emitted when the server closed it's connection.
154 \fn void QWebSocketServer::originAuthenticationRequired(QWebSocketCorsAuthenticator *authenticator)
155 This signal is emitted when a new connection is requested.
156 The slot connected to this signal should indicate whether the origin
157 (which can be determined by the origin() call) is allowed in the \a authenticator object
158 (by issuing \l{QWebSocketCorsAuthenticator::}{setAllowed()})
160 If no slot is connected to this signal, all origins will be accepted by default.
162 \note It is not possible to use a QueuedConnection to connect to
163 this signal, as the connection will always succeed.
167 \fn void QWebSocketServer::peerVerifyError(const QSslError &error)
169 QWebSocketServer can emit this signal several times during the SSL handshake,
170 before encryption has been established, to indicate that an error has
171 occurred while establishing the identity of the peer. The \a error is
172 usually an indication that QWebSocketServer is unable to securely identify the
175 This signal provides you with an early indication when something's wrong.
176 By connecting to this signal, you can manually choose to tear down the
177 connection from inside the connected slot before the handshake has
178 completed. If no action is taken, QWebSocketServer will proceed to emitting
179 QWebSocketServer::sslErrors().
185 \fn void QWebSocketServer::sslErrors(const QList<QSslError> &errors)
187 QWebSocketServer emits this signal after the SSL handshake to indicate that one
188 or more errors have occurred while establishing the identity of the
189 peer. The errors are usually an indication that QWebSocketServer is unable to
190 securely identify the peer. Unless any action is taken, the connection
191 will be dropped after this signal has been emitted.
193 \a errors contains one or more errors that prevent QSslSocket from
194 verifying the identity of the peer.
196 \sa peerVerifyError()
200 \enum QWebSocketServer::SslMode
201 Indicates whether the server operates over wss (SecureMode) or ws (NonSecureMode)
203 \value SecureMode The server operates in secure mode (over wss)
204 \value NonSecureMode The server operates in non-secure mode (over ws)
207 #include "qwebsocketprotocol.h"
208 #include "qwebsocket.h"
209 #include "qwebsocketserver.h"
210 #include "qwebsocketserver_p.h"
212 #include <QtNetwork/QTcpServer>
213 #include <QtNetwork/QTcpSocket>
214 #include <QtNetwork/QNetworkProxy>
217 #include <QtNetwork/QSslConfiguration>
223 Constructs a new QWebSocketServer with the given \a serverName.
224 The \a serverName will be used in the http handshake phase to identify the server.
225 It can be empty, in which case an empty server name will be sent to the client.
226 The \a secureMode parameter indicates whether the server operates over wss (\l{SecureMode})
227 or over ws (\l{NonSecureMode}).
229 \a parent is passed to the QObject constructor.
231 QWebSocketServer::QWebSocketServer(const QString &serverName, SslMode secureMode,
233 QObject(*(new QWebSocketServerPrivate(serverName,
235 (secureMode == SecureMode) ?
236 QWebSocketServerPrivate::SecureMode :
237 QWebSocketServerPrivate::NonSecureMode,
239 QWebSocketServerPrivate::NonSecureMode,
246 Q_D(QWebSocketServer);
251 Destroys the QWebSocketServer object. If the server is listening for connections,
252 the socket is automatically closed.
253 Any client \l{QWebSocket}s that are still queued are closed and deleted.
257 QWebSocketServer::~QWebSocketServer()
262 Closes the server. The server will no longer listen for incoming connections.
264 void QWebSocketServer::close()
266 Q_D(QWebSocketServer);
271 Returns a human readable description of the last error that occurred.
272 If no error occurred, an empty string is returned.
276 QString QWebSocketServer::errorString() const
278 Q_D(const QWebSocketServer);
279 return d->errorString();
283 Returns true if the server has pending connections; otherwise returns false.
285 \sa nextPendingConnection(), setMaxPendingConnections()
287 bool QWebSocketServer::hasPendingConnections() const
289 Q_D(const QWebSocketServer);
290 return d->hasPendingConnections();
294 Returns true if the server is currently listening for incoming connections;
295 otherwise returns false. If listening fails, error() will return the reason.
297 \sa listen(), error()
299 bool QWebSocketServer::isListening() const
301 Q_D(const QWebSocketServer);
302 return d->isListening();
306 Tells the server to listen for incoming connections on address \a address and port \a port.
307 If \a port is 0, a port is chosen automatically.
308 If \a address is QHostAddress::Any, the server will listen on all network interfaces.
310 Returns true on success; otherwise returns false.
314 bool QWebSocketServer::listen(const QHostAddress &address, quint16 port)
316 Q_D(QWebSocketServer);
317 return d->listen(address, port);
321 Returns the maximum number of pending accepted connections. The default is 30.
323 \sa setMaxPendingConnections(), hasPendingConnections()
325 int QWebSocketServer::maxPendingConnections() const
327 Q_D(const QWebSocketServer);
328 return d->maxPendingConnections();
332 Returns the next pending connection as a connected QWebSocket object.
333 QWebSocketServer does not take ownership of the returned QWebSocket object.
334 It is up to the caller to delete the object explicitly when it is done using it,
335 otherwise a memory leak will occur.
336 Q_NULLPTR is returned if this function is called when there are no pending connections.
338 Note: The returned QWebSocket object cannot be used from another thread.
340 \sa hasPendingConnections()
342 QWebSocket *QWebSocketServer::nextPendingConnection()
344 Q_D(QWebSocketServer);
345 return d->nextPendingConnection();
349 Pauses incoming new connections. Queued connections will remain in queue.
350 \sa resumeAccepting()
352 void QWebSocketServer::pauseAccepting()
354 Q_D(QWebSocketServer);
358 #ifndef QT_NO_NETWORKPROXY
360 Returns the network proxy for this server. By default QNetworkProxy::DefaultProxy is used.
364 QNetworkProxy QWebSocketServer::proxy() const
366 Q_D(const QWebSocketServer);
371 Sets the explicit network proxy for this server to \a networkProxy.
373 To disable the use of a proxy, use the QNetworkProxy::NoProxy proxy type:
376 server->setProxy(QNetworkProxy::NoProxy);
381 void QWebSocketServer::setProxy(const QNetworkProxy &networkProxy)
383 Q_D(QWebSocketServer);
384 d->setProxy(networkProxy);
390 Sets the SSL configuration for the QWebSocketServer to \a sslConfiguration.
391 This method has no effect if QWebSocketServer runs in non-secure mode
392 (QWebSocketServer::NonSecureMode).
394 \sa sslConfiguration(), SslMode
396 void QWebSocketServer::setSslConfiguration(const QSslConfiguration &sslConfiguration)
398 Q_D(QWebSocketServer);
399 d->setSslConfiguration(sslConfiguration);
403 Returns the SSL configuration used by the QWebSocketServer.
404 If the server is not running in secure mode (QWebSocketServer::SecureMode),
405 this method returns QSslConfiguration::defaultConfiguration().
407 \sa setSslConfiguration(), SslMode, QSslConfiguration::defaultConfiguration()
409 QSslConfiguration QWebSocketServer::sslConfiguration() const
411 Q_D(const QWebSocketServer);
412 return d->sslConfiguration();
417 Resumes accepting new connections.
420 void QWebSocketServer::resumeAccepting()
422 Q_D(QWebSocketServer);
423 d->resumeAccepting();
427 Sets the server name that will be used during the http handshake phase to the given
429 The \a serverName can be empty, in which case an empty server name will be sent to the client.
430 Existing connected clients will not be notified of this change, only newly connecting clients
431 will see this new name.
433 void QWebSocketServer::setServerName(const QString &serverName)
435 Q_D(QWebSocketServer);
436 d->setServerName(serverName);
440 Returns the server name that is used during the http handshake phase.
442 QString QWebSocketServer::serverName() const
444 Q_D(const QWebSocketServer);
445 return d->serverName();
449 Returns the server's address if the server is listening for connections; otherwise returns
452 \sa serverPort(), listen()
454 QHostAddress QWebSocketServer::serverAddress() const
456 Q_D(const QWebSocketServer);
457 return d->serverAddress();
461 Returns the secure mode the server is running in.
463 \sa QWebSocketServer(), SslMode
465 QWebSocketServer::SslMode QWebSocketServer::secureMode() const
468 Q_D(const QWebSocketServer);
469 return (d->secureMode() == QWebSocketServerPrivate::SecureMode) ?
470 QWebSocketServer::SecureMode : QWebSocketServer::NonSecureMode;
472 return QWebSocketServer::NonSecureMode;
477 Returns an error code for the last error that occurred.
478 If no error occurred, QWebSocketProtocol::CloseCodeNormal is returned.
482 QWebSocketProtocol::CloseCode QWebSocketServer::error() const
484 Q_D(const QWebSocketServer);
485 return d->serverError();
489 Returns the server's port if the server is listening for connections; otherwise returns 0.
491 \sa serverAddress(), listen()
493 quint16 QWebSocketServer::serverPort() const
495 Q_D(const QWebSocketServer);
496 return d->serverPort();
500 Sets the maximum number of pending accepted connections to \a numConnections.
501 WebSocketServer will accept no more than \a numConnections incoming connections before
502 nextPendingConnection() is called.
503 By default, the limit is 30 pending connections.
505 QWebSocketServer will emit the error() signal with
506 the QWebSocketProtocol::CloseCodeAbnormalDisconnection close code
507 when the maximum of connections has been reached.
508 The websocket handshake will fail and the socket will be closed.
510 \sa maxPendingConnections(), hasPendingConnections()
512 void QWebSocketServer::setMaxPendingConnections(int numConnections)
514 Q_D(QWebSocketServer);
515 d->setMaxPendingConnections(numConnections);
519 Sets the socket descriptor this server should use when listening for incoming connections to
522 Returns true if the socket is set successfully; otherwise returns false.
523 The socket is assumed to be in listening state.
525 \sa socketDescriptor(), isListening()
527 bool QWebSocketServer::setSocketDescriptor(int socketDescriptor)
529 Q_D(QWebSocketServer);
530 return d->setSocketDescriptor(socketDescriptor);
534 Returns the native socket descriptor the server uses to listen for incoming instructions,
535 or -1 if the server is not listening.
536 If the server is using QNetworkProxy, the returned descriptor may not be usable with
537 native socket functions.
539 \sa setSocketDescriptor(), isListening()
541 int QWebSocketServer::socketDescriptor() const
543 Q_D(const QWebSocketServer);
544 return d->socketDescriptor();
548 Returns a list of websocket versions that this server is supporting.
550 QList<QWebSocketProtocol::Version> QWebSocketServer::supportedVersions() const
552 Q_D(const QWebSocketServer);
553 return d->supportedVersions();