QML interface to QWebSocket. More...
Import Statement: | import QtWebSockets |
Since: | Qt 5.3 |
WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011.
active : bool
When set to true, a connection is made to the server with the given url. When set to false, the connection is closed. The default value is false.
errorString : QString
Contains a description of the last error that occurred. When no error occurrred, this string is empty.
status : Status
Status of the WebSocket.
The status can have the following values:
url : QUrl
Server url to connect to. The url must have one of 2 schemes: ws:// or wss://. When not supplied, then ws:// is used.
[since 5.8]
binaryMessageReceived(QString message)
This signal is emitted when a binary message is received. message contains the bytes received.
Note: The corresponding handler is onBinaryMessageReceived
.
This signal was introduced in Qt 5.8.
statusChanged(Status status)
This signal is emitted when the status of the WebSocket changes. The status argument provides the current status.
Note: The corresponding handler is onStatusChanged
.
See also WebSocket::status.
textMessageReceived(QString message)
This signal is emitted when a text message is received. message contains the bytes received.
Note: The corresponding handler is onTextMessageReceived
.
[since 5.8]
void sendBinaryMessage(ArrayBuffer message)
Sends the parameter message to the server.
This method was introduced in Qt 5.8.
void sendTextMessage(string message)
Sends message to the server.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-6.2/qml-qtwebsockets-websocket.html