src/websockets/qwebsocketserver.cpp

   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 /*!
  43     \class QWebSocketServer
  44
  45     \inmodule QtWebSockets
  46
  47     \brief Implements a websocket-based server.
  48
  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.
  55
  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.
  60
  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.
  63
  64     When listening for connections, the address and port on which the server is listening are
  65     available as serverAddress() and serverPort().
  66
  67     Calling close() makes QWebSocketServer stop listening for incoming connections.
  68
  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}.
  72
  73     QWebSocketServer only supports version 13 of the WebSocket protocol, as outlined in RFC 6455.
  74
  75     \sa echoserver.html
  76
  77     \sa QWebSocket
  78 */
  79
  80 /*!
  81   \page echoserver.html example
  82   \title WebSocket server example
  83   \brief A sample websocket server echoing back messages sent to it.
  84
  85   \section1 Description
  86   The echoserver example implements a web socket server that echoes back everything that is sent
  87   to it.
  88   \section1 Code
  89   We start by creating a QWebSocketServer (`new QWebSocketServer()`). After the creation, we listen
  90   on all local network interfaces (`QHostAddress::Any`) on the specified \a port.
  91   \snippet echoserver/echoserver.cpp constructor
  92   If listening is successful, we connect the `newConnection()` signal to the slot
  93   `onNewConnection()`.
  94   The `newConnection()` signal will be thrown whenever a new web socket client is connected to our
  95   server.
  96
  97   \snippet echoserver/echoserver.cpp onNewConnection
  98   When a new connection is received, the client QWebSocket is retrieved (`nextPendingConnection()`),
  99   and the signals we are interested in are connected to our slots
 100   (`textMessageReceived()`, `binaryMessageReceived()` and `disconnected()`).
 101   The client socket is remembered in a list, in case we would like to use it later
 102   (in this example, nothing is done with it).
 103
 104   \snippet echoserver/echoserver.cpp processTextMessage
 105   Whenever `processTextMessage()` is triggered, we retrieve the sender, and if valid, send back the
 106   original message (`sendTextMessage()`).
 107   The same is done with binary messages.
 108   \snippet echoserver/echoserver.cpp processBinaryMessage
 109   The only difference is that the message now is a QByteArray instead of a QString.
 110
 111   \snippet echoserver/echoserver.cpp socketDisconnected
 112   Whenever a socket is disconnected, we remove it from the clients list and delete the socket.
 113   Note: it is best to use `deleteLater()` to delete the socket.
 114 */
 115
 116 /*!
 117     \fn void QWebSocketServer::acceptError(QAbstractSocket::SocketError socketError)
 118     This signal is emitted when accepting a new connection results in an error.
 119     The \a socketError parameter describes the type of error that occurred
 120
 121     \sa pauseAccepting(), resumeAccepting()
 122 */
 123
 124 /*!
 125     \fn void QWebSocketServer::serverError(QWebSocketProtocol::CloseCode closeCode)
 126     This signal is emitted when an error occurs during the setup of a web socket connection.
 127     The \a closeCode parameter describes the type of error that occurred
 128
 129     \sa errorString()
 130 */
 131
 132 /*!
 133     \fn void QWebSocketServer::newConnection()
 134     This signal is emitted every time a new connection is available.
 135
 136     \sa hasPendingConnections(), nextPendingConnection()
 137 */
 138
 139 /*!
 140     \fn void QWebSocketServer::closed()
 141     This signal is emitted when the server closed it's connection.
 142
 143     \sa close()
 144 */
 145
 146 /*!
 147     \fn void QWebSocketServer::originAuthenticationRequired(QWebSocketCorsAuthenticator *authenticator)
 148     This signal is emitted when a new connection is requested.
 149     The slot connected to this signal should indicate whether the origin
 150     (which can be determined by the origin() call) is allowed in the \a authenticator object
 151     (by issuing \l{QWebSocketCorsAuthenticator::}{setAllowed()})
 152
 153     If no slot is connected to this signal, all origins will be accepted by default.
 154
 155     \note It is not possible to use a QueuedConnection to connect to
 156     this signal, as the connection will always succeed.
 157 */
 158
 159 /*!
 160     \fn void QWebSocketServer::peerVerifyError(const QSslError &error)
 161
 162     QWebSocketServer can emit this signal several times during the SSL handshake,
 163     before encryption has been established, to indicate that an error has
 164     occurred while establishing the identity of the peer. The \a error is
 165     usually an indication that QWebSocketServer is unable to securely identify the
 166     peer.
 167
 168     This signal provides you with an early indication when something's wrong.
 169     By connecting to this signal, you can manually choose to tear down the
 170     connection from inside the connected slot before the handshake has
 171     completed. If no action is taken, QWebSocketServer will proceed to emitting
 172     QWebSocketServer::sslErrors().
 173
 174     \sa sslErrors()
 175 */
 176
 177 /*!
 178     \fn void QWebSocketServer::sslErrors(const QList<QSslError> &errors)
 179
 180     QWebSocketServer emits this signal after the SSL handshake to indicate that one
 181     or more errors have occurred while establishing the identity of the
 182     peer. The errors are usually an indication that QWebSocketServer is unable to
 183     securely identify the peer. Unless any action is taken, the connection
 184     will be dropped after this signal has been emitted.
 185
 186     \a errors contains one or more errors that prevent QSslSocket from
 187     verifying the identity of the peer.
 188
 189     \sa peerVerifyError()
 190 */
 191
 192 /*!
 193   \enum QWebSocketServer::SslMode
 194   Indicates whether the server operates over wss (SecureMode) or ws (NonSecureMode)
 195
 196   \value SecureMode The server operates in secure mode (over wss)
 197   \value NonSecureMode The server operates in non-secure mode (over ws)
 198   */
 199
 200 #include "qwebsocketprotocol.h"
 201 #include "qwebsocket.h"
 202 #include "qwebsocketserver.h"
 203 #include "qwebsocketserver_p.h"
 204
 205 #include <QtNetwork/QTcpServer>
 206 #include <QtNetwork/QTcpSocket>
 207 #include <QtNetwork/QNetworkProxy>
 208
 209 #ifndef QT_NO_SSL
 210 #include <QtNetwork/QSslConfiguration>
 211 #endif
 212
 213 QT_BEGIN_NAMESPACE
 214
 215 /*!
 216     Constructs a new QWebSocketServer with the given \a serverName.
 217     The \a serverName will be used in the http handshake phase to identify the server.
 218     It can be empty, in which case an empty server name will be sent to the client.
 219     The \a secureMode parameter indicates whether the server operates over wss (\l{SecureMode})
 220     or over ws (\l{NonSecureMode}).
 221
 222     \a parent is passed to the QObject constructor.
 223  */
 224 QWebSocketServer::QWebSocketServer(const QString &serverName, SslMode secureMode,
 225                                    QObject *parent) :
 226     QObject(*(new QWebSocketServerPrivate(serverName,
 227                                       #ifndef QT_NO_SSL
 228                                       (secureMode == SecureMode) ?
 229                                           QWebSocketServerPrivate::SecureMode :
 230                                           QWebSocketServerPrivate::NonSecureMode,
 231                                       #else
 232                                       QWebSocketServerPrivate::NonSecureMode,
 233                                       #endif
 234                                       this)), parent)
 235 {
 236 #ifdef QT_NO_SSL
 237     Q_UNUSED(secureMode)
 238 #endif
 239 }
 240
 241 /*!
 242     Destroys the QWebSocketServer object. If the server is listening for connections,
 243     the socket is automatically closed.
 244     Any client \l{QWebSocket}s that are still queued are closed and deleted.
 245
 246     \sa close()
 247  */
 248 QWebSocketServer::~QWebSocketServer()
 249 {
 250 }
 251
 252 /*!
 253   Closes the server. The server will no longer listen for incoming connections.
 254  */
 255 void QWebSocketServer::close()
 256 {
 257     Q_D(QWebSocketServer);
 258     d->close();
 259 }
 260
 261 /*!
 262     Returns a human readable description of the last error that occurred.
 263     If no error occurred, an empty string is returned.
 264
 265     \sa serverError()
 266 */
 267 QString QWebSocketServer::errorString() const
 268 {
 269     Q_D(const QWebSocketServer);
 270     return d->errorString();
 271 }
 272
 273 /*!
 274     Returns true if the server has pending connections; otherwise returns false.
 275
 276     \sa nextPendingConnection(), setMaxPendingConnections()
 277  */
 278 bool QWebSocketServer::hasPendingConnections() const
 279 {
 280     Q_D(const QWebSocketServer);
 281     return d->hasPendingConnections();
 282 }
 283
 284 /*!
 285     Returns true if the server is currently listening for incoming connections;
 286     otherwise returns false. If listening fails, error() will return the reason.
 287
 288     \sa listen(), error()
 289  */
 290 bool QWebSocketServer::isListening() const
 291 {
 292     Q_D(const QWebSocketServer);
 293     return d->isListening();
 294 }
 295
 296 /*!
 297     Tells the server to listen for incoming connections on address \a address and port \a port.
 298     If \a port is 0, a port is chosen automatically.
 299     If \a address is QHostAddress::Any, the server will listen on all network interfaces.
 300
 301     Returns true on success; otherwise returns false.
 302
 303     \sa isListening()
 304  */
 305 bool QWebSocketServer::listen(const QHostAddress &address, quint16 port)
 306 {
 307     Q_D(QWebSocketServer);
 308     return d->listen(address, port);
 309 }
 310
 311 /*!
 312     Returns the maximum number of pending accepted connections. The default is 30.
 313
 314     \sa setMaxPendingConnections(), hasPendingConnections()
 315  */
 316 int QWebSocketServer::maxPendingConnections() const
 317 {
 318     Q_D(const QWebSocketServer);
 319     return d->maxPendingConnections();
 320 }
 321
 322 /*!
 323     Returns the next pending connection as a connected QWebSocket object.
 324     QWebSocketServer does not take ownership of the returned QWebSocket object.
 325     It is up to the caller to delete the object explicitly when it is done using it,
 326     otherwise a memory leak will occur.
 327     Q_NULLPTR is returned if this function is called when there are no pending connections.
 328
 329     Note: The returned QWebSocket object cannot be used from another thread.
 330
 331     \sa hasPendingConnections()
 332 */
 333 QWebSocket *QWebSocketServer::nextPendingConnection()
 334 {
 335     Q_D(QWebSocketServer);
 336     return d->nextPendingConnection();
 337 }
 338
 339 /*!
 340     Pauses incoming new connections. Queued connections will remain in queue.
 341     \sa resumeAccepting()
 342  */
 343 void QWebSocketServer::pauseAccepting()
 344 {
 345     Q_D(QWebSocketServer);
 346     d->pauseAccepting();
 347 }
 348
 349 #ifndef QT_NO_NETWORKPROXY
 350 /*!
 351     Returns the network proxy for this server. By default QNetworkProxy::DefaultProxy is used.
 352
 353     \sa setProxy()
 354 */
 355 QNetworkProxy QWebSocketServer::proxy() const
 356 {
 357     Q_D(const QWebSocketServer);
 358     return d->proxy();
 359 }
 360
 361 /*!
 362     Sets the explicit network proxy for this server to \a networkProxy.
 363
 364     To disable the use of a proxy, use the QNetworkProxy::NoProxy proxy type:
 365
 366     \code
 367         server->setProxy(QNetworkProxy::NoProxy);
 368     \endcode
 369
 370     \sa proxy()
 371 */
 372 void QWebSocketServer::setProxy(const QNetworkProxy &networkProxy)
 373 {
 374     Q_D(QWebSocketServer);
 375     d->setProxy(networkProxy);
 376 }
 377 #endif
 378
 379 #ifndef QT_NO_SSL
 380 /*!
 381     Sets the SSL configuration for the QWebSocketServer to \a sslConfiguration.
 382     This method has no effect if QWebSocketServer runs in non-secure mode
 383     (QWebSocketServer::NonSecureMode).
 384
 385     \sa sslConfiguration(), SslMode
 386  */
 387 void QWebSocketServer::setSslConfiguration(const QSslConfiguration &sslConfiguration)
 388 {
 389     Q_D(QWebSocketServer);
 390     d->setSslConfiguration(sslConfiguration);
 391 }
 392
 393 /*!
 394     Returns the SSL configuration used by the QWebSocketServer.
 395     If the server is not running in secure mode (QWebSocketServer::SecureMode),
 396     this method returns QSslConfiguration::defaultConfiguration().
 397
 398     \sa setSslConfiguration(), SslMode, QSslConfiguration::defaultConfiguration()
 399  */
 400 QSslConfiguration QWebSocketServer::sslConfiguration() const
 401 {
 402     Q_D(const QWebSocketServer);
 403     return d->sslConfiguration();
 404 }
 405 #endif
 406
 407 /*!
 408     Resumes accepting new connections.
 409     \sa pauseAccepting()
 410  */
 411 void QWebSocketServer::resumeAccepting()
 412 {
 413     Q_D(QWebSocketServer);
 414     d->resumeAccepting();
 415 }
 416
 417 /*!
 418     Sets the server name that will be used during the http handshake phase to the given
 419     \a serverName.
 420     The \a serverName can be empty, in which case an empty server name will be sent to the client.
 421     Existing connected clients will not be notified of this change, only newly connecting clients
 422     will see this new name.
 423  */
 424 void QWebSocketServer::setServerName(const QString &serverName)
 425 {
 426     Q_D(QWebSocketServer);
 427     d->setServerName(serverName);
 428 }
 429
 430 /*!
 431     Returns the server name that is used during the http handshake phase.
 432  */
 433 QString QWebSocketServer::serverName() const
 434 {
 435     Q_D(const QWebSocketServer);
 436     return d->serverName();
 437 }
 438
 439 /*!
 440     Returns the server's address if the server is listening for connections; otherwise returns
 441     QHostAddress::Null.
 442
 443     \sa serverPort(), listen()
 444  */
 445 QHostAddress QWebSocketServer::serverAddress() const
 446 {
 447     Q_D(const QWebSocketServer);
 448     return d->serverAddress();
 449 }
 450
 451 /*!
 452     Returns the secure mode the server is running in.
 453
 454     \sa QWebSocketServer(), SslMode
 455  */
 456 QWebSocketServer::SslMode QWebSocketServer::secureMode() const
 457 {
 458 #ifndef QT_NO_SSL
 459     Q_D(const QWebSocketServer);
 460     return (d->secureMode() == QWebSocketServerPrivate::SecureMode) ?
 461                 QWebSocketServer::SecureMode : QWebSocketServer::NonSecureMode;
 462 #else
 463     return QWebSocketServer::NonSecureMode;
 464 #endif
 465 }
 466
 467 /*!
 468     Returns an error code for the last error that occurred.
 469     If no error occurred, QWebSocketProtocol::CloseCodeNormal is returned.
 470
 471     \sa errorString()
 472  */
 473 QWebSocketProtocol::CloseCode QWebSocketServer::error() const
 474 {
 475     Q_D(const QWebSocketServer);
 476     return d->serverError();
 477 }
 478
 479 /*!
 480     Returns the server's port if the server is listening for connections; otherwise returns 0.
 481
 482     \sa serverAddress(), listen()
 483  */
 484 quint16 QWebSocketServer::serverPort() const
 485 {
 486     Q_D(const QWebSocketServer);
 487     return d->serverPort();
 488 }
 489
 490 /*!
 491     Sets the maximum number of pending accepted connections to \a numConnections.
 492     WebSocketServer will accept no more than \a numConnections incoming connections before
 493     nextPendingConnection() is called.
 494     By default, the limit is 30 pending connections.
 495
 496     Clients may still able to connect after the server has reached its maximum number of
 497     pending connections (i.e., QWebSocketServer can still emit the connected() signal).
 498     QWebSocketServer will stop accepting the new connections, but the operating system may still
 499     keep them in queue.
 500
 501     \sa maxPendingConnections(), hasPendingConnections()
 502  */
 503 void QWebSocketServer::setMaxPendingConnections(int numConnections)
 504 {
 505     Q_D(QWebSocketServer);
 506     d->setMaxPendingConnections(numConnections);
 507 }
 508
 509 /*!
 510     Sets the socket descriptor this server should use when listening for incoming connections to
 511     \a socketDescriptor.
 512
 513     Returns true if the socket is set successfully; otherwise returns false.
 514     The socket is assumed to be in listening state.
 515
 516     \sa socketDescriptor(), isListening()
 517  */
 518 bool QWebSocketServer::setSocketDescriptor(int socketDescriptor)
 519 {
 520     Q_D(QWebSocketServer);
 521     return d->setSocketDescriptor(socketDescriptor);
 522 }
 523
 524 /*!
 525     Returns the native socket descriptor the server uses to listen for incoming instructions,
 526     or -1 if the server is not listening.
 527     If the server is using QNetworkProxy, the returned descriptor may not be usable with
 528     native socket functions.
 529
 530     \sa setSocketDescriptor(), isListening()
 531  */
 532 int QWebSocketServer::socketDescriptor() const
 533 {
 534     Q_D(const QWebSocketServer);
 535     return d->socketDescriptor();
 536 }
 537
 538 /*!
 539   Returns a list of websocket versions that this server is supporting.
 540  */
 541 QList<QWebSocketProtocol::Version> QWebSocketServer::supportedVersions() const
 542 {
 543     Q_D(const QWebSocketServer);
 544     return d->supportedVersions();
 545 }
 546
 547 QT_END_NAMESPACE