WebSocket QML Type
QML-Schnittstelle zu QWebSocket. Mehr...
| Import Statement: | import QtWebSockets 1.10 |
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 von der IETF als RFC 6455 im Jahr 2011 standardisiert.
Dokumentation der Eigenschaft
active : bool |
Bei true wird eine Verbindung mit dem Server mit der angegebenen URL hergestellt. Bei false wird die Verbindung geschlossen. Der Standardwert ist false.
errorString : string |
Enthält eine Beschreibung des zuletzt aufgetretenen Fehlers. Wenn kein Fehler aufgetreten ist, ist diese Zeichenkette leer.
negotiatedSubprotocol : string |
Das WebSocket-Unterprotokoll, das mit dem Server ausgehandelt wurde.
Diese Eigenschaft wurde in Qt 6.4 eingeführt.
requestedSubprotocols : list<string> |
Die Liste der WebSocket-Subprotokolle, die im WebSocket-Handshake gesendet werden.
Diese Eigenschaft wurde in Qt 6.4 eingeführt.
status : Status |
Status des WebSockets.
Der Status kann die folgenden Werte haben:
- WebSocket.Connecting
- WebSocket.Offen
- WebSocket.Schließen
- WebSocket.Geschlossen
- WebSocket.Fehler
url : url |
Server-URL, zu der eine Verbindung hergestellt werden soll. Die Url muss eines von 2 Schemata haben: ws:// oder wss://. Wenn sie nicht angegeben wird, wird ws:// verwendet.
Signal Dokumentation
binaryMessageReceived(QString message) |
Dieses Signal wird ausgegeben, wenn eine binäre Nachricht empfangen wird. message enthält die empfangenen Bytes.
Hinweis: Der entsprechende Handler ist onBinaryMessageReceived.
|
Wird ausgesendet, wenn eine Pong-Nachricht als Antwort auf einen vorherigen 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 ausgesendet, wenn sich der Status des WebSockets ändert. Das Argument status liefert den aktuellen Status.
Hinweis: Der entsprechende Handler ist onStatusChanged.
Siehe auch WebSocket::status.
textMessageReceived(QString message) |
Dieses Signal wird ausgegeben, wenn eine Textnachricht empfangen wird. message enthält die empfangenen Bytes.
Hinweis: Der entsprechende Handler ist onTextMessageReceived.
Dokumentation der Methode
|
|
Pingt den Server an, um anzuzeigen, dass die Verbindung noch besteht. Eine zusätzliche payload kann zusammen mit der Ping-Nachricht gesendet werden.
Die Größe von payload darf nicht größer als 125 Byte sein. Ist sie größer, wird die payload auf 125 Byte gekürzt.
Hinweis: QWebSocket und QWebSocketServer verarbeiten Ping-Anfragen intern, d. h. sie senden automatisch eine Ping-Antwort an die Gegenstelle zurück.
Diese QML-Methode wurde 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.
© 2025 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.
