diff options
Diffstat (limited to 'src/websockets/qwebsocket.cpp')
| -rw-r--r-- | src/websockets/qwebsocket.cpp | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/src/websockets/qwebsocket.cpp b/src/websockets/qwebsocket.cpp index 93d07f4..b495ffd 100644 --- a/src/websockets/qwebsocket.cpp +++ b/src/websockets/qwebsocket.cpp @@ -98,6 +98,27 @@ not been filled in with new information when the signal returns. \sa QAuthenticator, QNetworkProxy */ + +/*! + \fn void QWebSocket::authenticationRequired(QAuthenticator *authenticator) + \since 6.6 + + This signal is emitted when the server requires authentication. + The \a authenticator object must then be filled in with the required details + to allow authentication and continue the connection. + + If you know that the server may require authentication, you can set the + username and password on the initial QUrl, using QUrl::setUserName and + QUrl::setPassword. QWebSocket will still try to connect \e{once} without + using the provided credentials. + + \note It is not possible to use a QueuedConnection to connect to + this signal, as the connection will fail if the authenticator has + not been filled in with new information when the signal returns. + + \sa QAuthenticator +*/ + /*! \fn void QWebSocket::stateChanged(QAbstractSocket::SocketState state); |