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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/****************************************************************************
**
** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtwebsockets-index.html
\since 5.3
\title Qt WebSockets
\brief Provides an implementation of the WebSocket protocol.
WebSocket is a web-based protocol designed to enable a two-way interactive
communication session between a client application and a remote host. It
enables the two entities to send data back and forth if the initial
handshake succeeds.
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.
\section1 Using the Module
\section2 QML API
\include {module-use.qdocinc} {using the qml api} {QtWebSockets}
\section2 C++ API
\include {module-use.qdocinc} {using the c++ api}
\section3 Building with CMake
\include {module-use.qdocinc} {building with cmake} {WebSockets}
\section3 Building with qmake
\include {module-use.qdocinc} {building_with_qmake} {websockets}
\section1 Examples
\list
\li \l {Qt WebSockets Examples}
\endlist
\section1 Reference
\list
\li \l {Qt WebSockets Overview} {Overview}
\li \l {Qt WebSockets C++ Classes} {C++ Classes}
\li \l {Qt WebSockets QML Types} {QML Types}
\endlist
\section1 Conformance
\list
\li \l {Testing Qt WebSockets}
\endlist
\section1 Licenses
Qt WebSockets is available under commercial licenses from \l{The Qt Company}.
In addition, it is available under free software licenses. Since Qt 5.4,
these free software licenses are
\l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
*/
/*!
\page qtwebsockets-testing.html
\title Testing Qt WebSockets
\l {Autobahn|Testsuite}, a standard test
suite for WebSocket Protocol (\l{RFC 6455}), can be used for testing the
conformance of Qt WebSockets. Refer to
\l {Autobahn|Testsuite installation documentation}
to set up the test suite.
\include README.qdocinc testsuite
*/
|
