WebSocket QML Type
Interfaz QML para QWebSocket. Más...
| Import Statement: | import QtWebSockets 1.11 |
Propiedades
- active : bool
- errorString : string
- negotiatedSubprotocol : string
(since 6.4) - requestedSubprotocols : list<string>
(since 6.4) - status : Status
- url : url
Señales
- binaryMessageReceived(QString message)
- pong(quint64 elapsedTime, ArrayBuffer payload)
(since 6.10) - statusChanged(Status status)
- textMessageReceived(QString message)
Métodos
- void ping()
(since 6.10) - void ping(ArrayBuffer payload)
(since 6.10) - void sendBinaryMessage(ArrayBuffer message)
- void sendTextMessage(string message)
Descripción detallada
WebSockets es una tecnología web que proporciona canales de comunicación full-duplex a través de una única conexión TCP. El protocolo WebSocket fue estandarizado por el IETF como RFC 6455 en 2011.
Documentación de propiedades
active : bool
Cuando se establece en true, se establece una conexión con el servidor con la url dada. Si es false, la conexión se cierra. El valor por defecto es false.
errorString : string [read-only]
Contiene una descripción del último error que se ha producido. Si no se ha producido ningún error, esta cadena está vacía.
negotiatedSubprotocol : string [read-only, since 6.4]
El subprotocolo WebSocket que se ha negociado con el servidor.
Esta propiedad se introdujo en Qt 6.4.
requestedSubprotocols : list<string> [since 6.4]
La lista de subprotocolos WebSocket a enviar en el handshake WebSocket.
Esta propiedad se introdujo en Qt 6.4.
status : Status [read-only]
Estado del WebSocket.
El estado puede tener los siguientes valores
- WebSocket.Conectando
- WebSocket.Abierto
- WebSocket.Cerrando
- WebSocket.Cerrado
- WebSocket.Error
url : url
Url del servidor al que conectarse. La url debe tener uno de 2 esquemas: ws:// o wss://. Si no se indica, se utiliza ws://.
Documentación de la señal
binaryMessageReceived(QString message)
Esta señal se emite cuando se recibe un mensaje binario. message contiene los bytes recibidos.
Nota: El manejador correspondiente es onBinaryMessageReceived.
[since 6.10] pong(quint64 elapsedTime, ArrayBuffer payload)
Se emite cuando se recibe un mensaje pong en respuesta a un ping anterior. elapsedTime contiene el tiempo de ida y vuelta en milisegundos y payload contiene una carga útil opcional que se envió con el ping.
Nota: El manejador correspondiente es onPong.
Esta señal se introdujo en Qt 6.10.
Véase también ping().
statusChanged(Status status)
Esta señal se emite cuando cambia el estado del WebSocket. El argumento status proporciona el estado actual.
Nota: El manejador correspondiente es onStatusChanged.
Véase también WebSocket::status.
textMessageReceived(QString message)
Esta señal se emite cuando se recibe un mensaje de texto. message contiene los bytes recibidos.
Nota: El manejador correspondiente es onTextMessageReceived.
Documentación del método
Hace ping al servidor para indicar que la conexión sigue viva. Se puede enviar un payload adicional junto con el mensaje ping.
El tamaño de payload no puede ser superior a 125 bytes. Si es mayor, payload se recorta a 125 bytes.
Nota: QWebSocket y QWebSocketServer gestionan las solicitudes de ping internamente, lo que significa que devuelven automáticamente una respuesta pong al peer.
Estos métodos fueron introducidos en Qt 6.10.
Véase también pong().
void sendBinaryMessage(ArrayBuffer message)
Envía el parámetro message al servidor.
void sendTextMessage(string message)
Envía message al servidor.
© 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.
