summaryrefslogtreecommitdiff
path: root/examples/websockets/doc/echoserver.qdoc
blob: e547e2a7da1863ae6b4362b676861094e35b827d (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtWebSockets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** As a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example echoserver
    \title Echo Server Example
    \ingroup qtwebsockets-examples
    \brief Shows how to create a simple server application that
    sends back the messages it receives.

    The Echo Server Example shows how to create a simple server application that
    sends back the messages it receives, using the \l {Qt WebSockets}{WebSocket} API.

    If your web browser supports \l {Qt WebSockets}{WebSocket}, you can also use it
    to open the \l {echoserver/echoclient.html}{echoclient.html} file, and operate
    like the following screenshot.

    \image echoclient-html-example.png Screenshot of the HTML version of Echo
    Client example

    \sa {Echo Client Example}
*/