aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndre Hartmann <aha_1980@gmx.de>2020-12-13 22:02:02 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-12-21 13:15:33 +0000
commite7883bc64440b1ff4666272ac6eb710ee4bc221b (patch)
treecd93d229fbbfac55abdfdae95c024a222770bea6
parentd1e892816fba1494d9a63fc22a88d78c2bbe0429 (diff)
Add doc note about internal ping/pong handling
Change-Id: Ic74407b17d03fbfd3077ac1dd4f689a7207ccb51 Reviewed-by: Christian Ehrlicher <ch.ehrlicher@gmx.de> Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit fa6c7e50321e7be048297e5d0ce8503647a9488e) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/websockets/qwebsocket.cpp3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp
index 144268f..526c561 100644
--- a/src/websockets/qwebsocket.cpp
+++ b/src/websockets/qwebsocket.cpp
@@ -447,6 +447,9 @@ void QWebSocket::open(const QNetworkRequest &request)
The size of the \a payload cannot be bigger than 125.
If it is larger, the \a payload is clipped to 125 bytes.
+ \note QWebSocket and QWebSocketServer handles ping requests internally,
+ which means they automatically send back a pong response to the peer.
+
\sa pong()
*/
void QWebSocket::ping(const QByteArray &payload)