WebSocket QML Type

Interface QML pour QWebSocket. Plus d'informations...

Import Statement: import QtWebSockets 1.10

Propriétés

Signaux

Méthodes

Description détaillée

WebSockets est une technologie web qui fournit des canaux de communication en duplex intégral sur une seule connexion TCP. Le protocole WebSocket a été normalisé par l'IETF en tant que RFC 6455 en 2011.

Propriété Documentation

active : bool

Lorsque cette propriété vaut true, une connexion est établie avec le serveur dont l'url est donnée. Lorsqu'elle vaut false, la connexion est fermée. La valeur par défaut est false.


errorString : string [read-only]

Contient une description de la dernière erreur survenue. Si aucune erreur ne s'est produite, cette chaîne est vide.


negotiatedSubprotocol : string [read-only, since 6.4]

Le sous-protocole WebSocket qui a été négocié avec le serveur.

Cette propriété a été introduite dans Qt 6.4.


requestedSubprotocols : list<string> [since 6.4]

La liste des sous-protocoles WebSocket à envoyer dans la poignée de main WebSocket.

Cette propriété a été introduite dans Qt 6.4.


status : Status [read-only]

Statut de la WebSocket.

L'état peut avoir les valeurs suivantes :

  • WebSocket.Connecting
  • WebSocket.Ouvert
  • WebSocket.Closing
  • WebSocket.Closed
  • WebSocket.Erreur

url : url

URL du serveur auquel se connecter. L'url doit avoir l'un des deux schémas suivants : ws:// ou wss://. Si elle n'est pas fournie, c'est ws:// qui est utilisé.


Documentation du signal

binaryMessageReceived(QString message)

Ce signal est émis lors de la réception d'un message binaire. message contient les octets reçus.

Remarque : le gestionnaire correspondant est onBinaryMessageReceived.


[since 6.10] pong(quint64 elapsedTime, ArrayBuffer payload)

Émis lorsqu'un message pong est reçu en réponse à un ping précédent. elapsedTime contient le temps d'aller-retour en millisecondes et payload contient une charge utile facultative qui a été envoyée avec le ping.

Remarque : le gestionnaire correspondant est onPong.

Ce signal a été introduit dans Qt 6.10.

Voir aussi ping().


statusChanged(Status status)

Ce signal est émis lorsque l'état de la WebSocket change. L'argument status fournit l'état actuel.

Remarque : le gestionnaire correspondant est onStatusChanged.

Voir aussi WebSocket::status.


textMessageReceived(QString message)

Ce signal est émis lors de la réception d'un message texte. message contient les octets reçus.

Remarque : Le gestionnaire correspondant est onTextMessageReceived.


Documentation de la méthode

[since 6.10] void ping()

[since 6.10] void ping(ArrayBuffer payload)

Effectue un ping sur le serveur pour indiquer que la connexion est toujours en cours. Un payload supplémentaire peut être envoyé avec le message ping.

La taille de payload ne peut être supérieure à 125 octets. Si elle est plus grande, la taille de payload est réduite à 125 octets.

Remarque : QWebSocket et QWebSocketServer gèrent les demandes de ping en interne, ce qui signifie qu'ils renvoient automatiquement une réponse pong à l'homologue.

Cette méthode Qt Qml a été introduite dans Qt 6.10.

Voir aussi pong().


void sendBinaryMessage(ArrayBuffer message)

Envoie le paramètre message au serveur.


void sendTextMessage(string message)

Envoie le paramètre message au serveur.


© 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.