WebSocket QML Type

QML interface to QWebSocket. More...

Import Statement: import QtWebSockets 1.13
Since: Qt 5.3




Detailed Description

WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011.

Property Documentation

active : bool

When set to true, a connection is made to the server with the given url. When set to false, the connection is closed. The default value is false.

errorString : QString

Contains a description of the last error that occurred. When no error occurrred, this string is empty.

status : Status

Status of the WebSocket.

The status can have the following values:

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

url : QUrl

Server url to connect to. The url must have one of 2 schemes: ws:// or wss://. When not supplied, then ws:// is used.

Signal Documentation


This signal is emitted when a binary message is received. message contains the bytes received.

This signal was introduced in Qt 5.8.


This signal is emitted when the status of the WebSocket changes. The status argument provides the current status.

See also WebSocket::status.


This signal is emitted when a text message is received. message contains the bytes received.

Method Documentation

void sendBinaryMessage(message)

Sends the parameter message to the server.

This method was introduced in Qt 5.8.

void sendTextMessage(message)

Sends message to the server.

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