summaryrefslogtreecommitdiff
path: root/src/websockets/qwebsocket.cpp
diff options
context:
space:
mode:
authorKurt Pattyn <pattyn.kurt@gmail.com>2014-01-04 13:57:19 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-01-04 14:58:56 +0100
commit7898899529c4882cac519df07baad8f85906e797 (patch)
tree090779ac6f63c973d52d54f785b33a3adf0f0245 /src/websockets/qwebsocket.cpp
parentac4ae5a8950a1756a5bd937d33e543a2ed7c8f25 (diff)
downloadqtwebsockets-7898899529c4882cac519df07baad8f85906e797.tar.gz
Add clarification in documentation
Change-Id: Ib616c4c932cb2797036d2d821af7726fcfe2f877 Reviewed-by: Kurt Pattyn <pattyn.kurt@gmail.com>
Diffstat (limited to 'src/websockets/qwebsocket.cpp')
-rw-r--r--src/websockets/qwebsocket.cpp5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 22722c2..943af56 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -80,6 +80,8 @@
/*!
\fn void QWebSocket::connected()
\brief Emitted when a connection is successfully established.
+ A connection is successfully established when the socket is connected
+ and the handshake was successful.
\sa open(), disconnected()
*/
/*!
@@ -116,6 +118,9 @@ not been filled in with new information when the signal returns.
This signal is emitted whenever QWebSocket's state changes.
The \a state parameter is the new state.
+ \note QAbstractSocket::ConnectedState is emitted after the handshake has
+ with the server has succeeded.
+
QAbstractSocket::SocketState is not a registered metatype, so for queued
connections, you will have to register it with Q_REGISTER_METATYPE() and
qRegisterMetaType().