WebSocket QML Type

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

• Liste de tous les membres, y compris les membres hérités

Propriétés

• active : bool
• errorString : string
• negotiatedSubprotocol : string (since 6.4)
• requestedSubprotocols : list<string> (since 6.4)
• status : Status
• url : url

Signaux

• binaryMessageReceived(QString message)
• pong(quint64 elapsedTime, ArrayBuffer payload) (since 6.10)
• statusChanged(Status status)
• textMessageReceived(QString message)

Méthodes

• void ping() (since 6.10)
• void ping(ArrayBuffer payload) (since 6.10)
• void sendBinaryMessage(ArrayBuffer message)
• void sendTextMessage(string message)

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.

Documentation sur les propriétés

active : bool

Lorsqu'il vaut true, une connexion est établie avec le serveur dont l'url est donnée. Si la valeur est 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.Fermé
• 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 sur le signal

binaryMessageReceived(QString message)

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

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

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 indique l'état actuel.

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.

Documentation de la méthode

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.

Ces méthodes ont été introduites dans Qt 6.10.

Voir aussi pong().

void sendBinaryMessage(ArrayBuffer message)

Envoie le paramètre message au serveur.

void sendTextMessage(string message)

Envoie message au serveur.