WebSocket QML Type

Interface QML vers QWebSocket. En savoir plus...

• 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 fournissant des canaux de communication en duplex intégral via une seule connexion TCP. Le protocole WebSocket a été normalisé par l'IETF sous la référence RFC 6455 en 2011.

Documentation des propriétés

active : bool

Lorsque cette option est définie sur « true », une connexion est établie avec le serveur via l'URL indiquée. Lorsqu'elle est définie sur « 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. Lorsqu'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]

Liste des sous-protocoles WebSocket à envoyer lors de la négociation WebSocket.

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

status : Status [read-only]

État du WebSocket.

L'état peut prendre les valeurs suivantes :

• WebSocket.Connecting
• WebSocket.Open
• WebSocket.Closing
• WebSocket.Closed
• WebSocket.Error

url : url

URL du serveur auquel se connecter. L'URL doit respecter l'un des deux schémas suivants : ws:// ou wss://. Si elle n'est pas fournie, le schéma ws:// est utilisé par défaut.

Documentation Signal

binaryMessageReceived(QString message)

Ce signal est émis lorsqu'un message binaire est reçu. La variable 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 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 également ping().

statusChanged(Status status)

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

Voir également WebSocket::status.

textMessageReceived(QString message)

Ce signal est émis lorsqu'un SMS est reçu. La variable ` message ` contient les octets reçus.

Documentation des méthodes

Envoie une requête « ping » au serveur pour indiquer que la connexion est toujours active. Une « payload » supplémentaire peut être envoyée avec le message « ping ».

La taille de l'payload ne doit pas dépasser 125 octets. Si elle est supérieure, l'payload est tronquée à 125 octets.

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

Voir également pong().

void sendBinaryMessage(ArrayBuffer message)

Envoie le paramètre « message » au serveur.

void sendTextMessage(string message)

Envoie l'message s au serveur.