blob: 2961ef3cf82003e0322cd58f002b9a13ea80ab02 (
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
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
|
/****************************************************************************
**
** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtwebsockets-index.html
\since 5.3
\title Qt WebSockets
\brief Provides an implementation of the WebSocket protocol.
The QtWebSockets module implements the WebSocket protocol as specified in
\l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
It solely depends on Qt (no external dependencies).
To use this module in your application, use the following include
statement:
\code
#include <QtWebSockets/QtWebSockets>
\endcode
To link against the module, add this line to your \l qmake \c
.pro file:
\code
QT += websockets
\endcode
\section1 Reference documentation
\list
\li \l{Qt WebSockets C++ Classes}{C++ Classes}
\li \l{Qt WebSockets QML Types}{QML Types}
\endlist
\section1 Examples
The module provides the following examples as a guide to using
the API.
\l{Qt WebSockets Examples}{Examples}
*/
|