1 /****************************************************************************
3 ** Copyright (C) 2013 Kurt Pattyn <pattyn.kurt@gmail.com>
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the documentation of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:FDL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Free Documentation License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Free
19 ** Documentation License version 1.3 as published by the Free Software
20 ** Foundation and appearing in the file included in the packaging of
21 ** this file. Please review the following information to ensure
22 ** the GNU Free Documentation License version 1.3 requirements
23 ** will be met: http://www.gnu.org/copyleft/fdl.html.
26 ****************************************************************************/
29 \page qtwebsockets-index.html
32 \brief Provides an implementation of the WebSocket protocol.
34 The QtWebSockets module implements the WebSocket protocol as specified in
35 \l {http://tools.ietf.org/html/rfc6455} {RFC 6455}.
36 It solely depends on Qt (no external dependencies).
39 To use this module in your application, use the following include
43 #include <QtWebSockets/QtWebSockets>
46 To link against the module, add this line to your \l qmake \c
53 \section1 Reference documentation
55 \li \l{Qt WebSockets C++ Classes}{C++ Classes}
56 \li \l{Qt WebSockets QML Types}{QML Types}
61 The module provides the following examples as a guide to using
63 \l{Qt WebSockets Examples}{Examples}