aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras/QtWebSockets.rst
blob: f15264699f9210c23976907ea03de41c8f6e2cac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Provides an implementation of the WebSocket protocol.

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 modules classes, use the following
directive:

::

    import PySide6.QtWebSockets

The module also provides `QML types <https://doc.qt.io/qt-6/qtwebsockets-qmlmodule.html>`_ .

Articles and Guides
^^^^^^^^^^^^^^^^^^^

    * `Overview <https://doc.qt.io/qt-6/websockets-overview.html>`_
    * `Testing Qt WebSockets <https://doc.qt.io/qt-6/qtwebsockets-testing.html>`_