diff options
| author | Kurt Pattyn <pattyn.kurt@gmail.com> | 2014-02-02 18:38:19 +0100 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-02-02 18:41:11 +0100 |
| commit | bae48981dacae436ff4b1a212cc7cfb7e78a3431 (patch) | |
| tree | 3ad1e60c384726421dad58f6f9be2d7ce072df75 /src/websockets/qwebsocketserver.cpp | |
| parent | 9f080442a6d99a43f76cf7a4f568ceeddecbb019 (diff) | |
| download | qtwebsockets-bae48981dacae436ff4b1a212cc7cfb7e78a3431.tar.gz | |
Update documentation
Change-Id: I35829436b3be543fd133cab58118e62ddfb0e291
Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocketserver.cpp')
| -rw-r--r-- | src/websockets/qwebsocketserver.cpp | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/websockets/qwebsocketserver.cpp b/src/websockets/qwebsocketserver.cpp index 30ff88d..28a7675 100644 --- a/src/websockets/qwebsocketserver.cpp +++ b/src/websockets/qwebsocketserver.cpp @@ -215,6 +215,7 @@ QT_BEGIN_NAMESPACE /*! Constructs a new QWebSocketServer with the given \a serverName. The \a serverName will be used in the http handshake phase to identify the server. + It can be empty, in which case an empty server name will be sent to the client. The \a secureMode parameter indicates whether the server operates over wss (\l{SecureMode}) or over ws (\l{NonSecureMode}). @@ -262,6 +263,7 @@ void QWebSocketServer::close() /*! Returns a human readable description of the last error that occurred. + If no error occurred, an empty string is returned. \sa serverError() */ @@ -284,9 +286,9 @@ bool QWebSocketServer::hasPendingConnections() const /*! Returns true if the server is currently listening for incoming connections; - otherwise returns false. + otherwise returns false. If listening fails, error() will return the reason. - \sa listen() + \sa listen(), error() */ bool QWebSocketServer::isListening() const { @@ -467,6 +469,7 @@ QWebSocketServer::SslMode QWebSocketServer::secureMode() const /*! Returns an error code for the last error that occurred. + If no error occurred, QWebSocketProtocol::CloseCodeNormal is returned. \sa errorString() */ |