WebSocket is a web-based protocol designed to enable two-way communication between a client application and a remote host. It enables the two entities to send data back and forth if the initial handshake succeeds. WebSocket is the solution for applications that struggle to get real-time data feeds with less network latency and minimum data exchange.

The Qt WebSockets module provides C++ and QML interfaces that enable Qt applications to act as a server that can process WebSocket requests, or a client that can consume data received from the server, or both.

Getting Started

To include the definitions of the module's classes, use the following directive:

#include <QtWebSockets/QtWebSockets>

To import the QML types into your application, use the following import statement in your .qml file:

import QtWebSockets 1.0

To link against the module, add this line to your qmake .pro file:

QT += websockets

Licenses

Qt WebSockets is available under commercial licenses from The Qt Company. In addition, it is available under free software licenses. Since Qt 5.4, these free software licenses are GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.

Reference Documentation

• Overview
• C++ Classes
• QML Types

Examples

The module provides the following Examples as a guide to using the API.

Conformance

• Testing Qt WebSockets