WebSocket QML Type
QML-Schnittstelle zu „ QWebSocket “. Mehr...
| Import Statement: | import QtWebSockets 1.12 |
Eigenschaften
- active : bool
- errorString : string
- negotiatedSubprotocol : string
(since 6.4) - requestedSubprotocols : list<string>
(since 6.4) - status : Status
- url : url
Signale
- binaryMessageReceived(QString message)
- pong(quint64 elapsedTime, ArrayBuffer payload)
(since 6.10) - statusChanged(Status status)
- textMessageReceived(QString message)
Methoden
- void ping()
(since 6.10) - void ping(ArrayBuffer payload)
(since 6.10) - void sendBinaryMessage(ArrayBuffer message)
- void sendTextMessage(string message)
Ausführliche Beschreibung
WebSockets ist eine Webtechnologie, die Vollduplex-Kommunikationskanäle über eine einzige TCP-Verbindung bereitstellt. Das WebSocket-Protokoll wurde 2011 von der IETF als RFC 6455 standardisiert.
Dokumentation der Eigenschaften
active : bool
Ist dieser Wert auf „true“ gesetzt, wird eine Verbindung zum Server über die angegebene URL hergestellt. Ist er auf „false“ gesetzt, wird die Verbindung geschlossen. Der Standardwert ist „false“.
errorString : string [read-only]
Enthält eine Beschreibung des zuletzt aufgetretenen Fehlers. Wenn kein Fehler aufgetreten ist, ist diese Zeichenfolge leer.
negotiatedSubprotocol : string [read-only, since 6.4]
Das mit dem Server ausgehandelte WebSocket-Teilprotokoll.
Diese Eigenschaft wurde in Qt 6.4 eingeführt.
requestedSubprotocols : list<string> [since 6.4]
Die Liste der WebSocket-Subprotokolle, die im WebSocket-Handshake gesendet werden sollen.
Diese Eigenschaft wurde in Qt 6.4 eingeführt.
status : Status [read-only]
Status des WebSockets.
Der Status kann folgende Werte annehmen:
- WebSocket.Connecting
- WebSocket.Open
- WebSocket.Closing
- WebSocket.Geschlossen
- WebSocket.Fehler
url : url
URL des Servers, mit dem eine Verbindung hergestellt werden soll. Die URL muss eines der beiden folgenden Schemata aufweisen: ws:// oder wss://. Wird keine URL angegeben, wird ws:// verwendet.
Signal-Dokumentation
binaryMessageReceived(QString message)
Dieses Signal wird ausgelöst, wenn eine binäre Nachricht empfangen wird. „ message “ enthält die empfangenen Bytes.
Hinweis: Der entsprechende Handler ist „ onBinaryMessageReceived “.
[since 6.10] pong(quint64 elapsedTime, ArrayBuffer payload)
Wird ausgelöst, wenn eine Pong-Nachricht als Antwort auf einen zuvor gesendeten Ping empfangen wird. „ elapsedTime “ enthält die Roundtrip-Zeit in Millisekunden und „ payload “ enthält eine optionale Nutzlast, die mit dem Ping gesendet wurde.
Hinweis: Der entsprechende Handler ist „ onPong “.
Dieses Signal wurde in Qt 6.10 eingeführt.
Siehe auch ping().
statusChanged(Status status)
Dieses Signal wird ausgelöst, wenn sich der Status des WebSockets ändert. Das Argument „ status “ gibt den aktuellen Status an.
Hinweis: Der entsprechende Handler lautet „ onStatusChanged “.
Siehe auch „ WebSocket::status “.
textMessageReceived(QString message)
Dieses Signal wird ausgelöst, wenn eine Textnachricht empfangen wird. „ message “ enthält die empfangenen Bytes.
Hinweis: Der entsprechende Handler ist ` onTextMessageReceived`.
Methodendokumentation
Sendet einen Ping an den Server, um anzuzeigen, dass die Verbindung noch besteht. Zusammen mit der Ping-Nachricht kann ein zusätzlicher „ payload “ gesendet werden.
Die Größe der „ payload “-Datei darf 125 Byte nicht überschreiten. Ist sie größer, wird die Datei „ payload “ auf 125 Byte gekürzt.
Hinweis: „ QWebSocket “ und „ QWebSocketServer “ verarbeiten Ping-Anfragen intern, was bedeutet, dass sie automatisch eine Pong-Antwort an den Peer zurücksenden.
Diese Methoden wurden in Qt 6.10 eingeführt.
Siehe auch pong().
void sendBinaryMessage(ArrayBuffer message)
Sendet den Parameter „ message “ an den Server.
void sendTextMessage(string message)
Sendet „ message “ an den Server.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
