aboutsummaryrefslogtreecommitdiffstats
path: root/examples/websockets/doc/echoserver.qdoc
blob: 470474f164789e450d4d43f8f0e1b74d9bbd140d (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause

/*!
    \example echoserver
    \title WebSocket Echo Server
    \examplecategory {Networking}
    \ingroup qtwebsockets-examples
    \brief Show how to write a simple WebSocket server application.

    This Echo Server shows how to create a simple server application that sends
    back a reply in response to a message it receives, using the
    \l {Qt WebSockets}{WebSocket} API. For the sake of illustration, the reply
    is simply a copy of the message.

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

    \image echoclient-html-example.png WebSocket Echo HTML Client

    Otherwise use the \l {WebSocket Echo Client} to connect to the server.

    \sa {WebSocket Echo Client}
*/