diff options
Diffstat (limited to 'examples/websockets/doc/echoserver.qdoc')
| -rw-r--r-- | examples/websockets/doc/echoserver.qdoc | 72 |
1 files changed, 14 insertions, 58 deletions
diff --git a/examples/websockets/doc/echoserver.qdoc b/examples/websockets/doc/echoserver.qdoc index 76a37ce..470474f 100644 --- a/examples/websockets/doc/echoserver.qdoc +++ b/examples/websockets/doc/echoserver.qdoc @@ -1,69 +1,25 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtWebSockets module of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:BSD$ -** 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. -** -** BSD License Usage -** Alternatively, you may use this file under the terms of the BSD license -** as follows: -** -** "Redistribution and use in source and binary forms, with or without -** modification, are permitted provided that the following conditions are -** met: -** * Redistributions of source code must retain the above copyright -** notice, this list of conditions and the following disclaimer. -** * Redistributions in binary form must reproduce the above copyright -** notice, this list of conditions and the following disclaimer in -** the documentation and/or other materials provided with the -** distribution. -** * Neither the name of The Qt Company Ltd nor the names of its -** contributors may be used to endorse or promote products derived -** from this software without specific prior written permission. -** -** -** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." -** -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause /*! \example echoserver - \title Echo Server Example + \title WebSocket Echo Server + \examplecategory {Networking} \ingroup qtwebsockets-examples - \brief Shows how to create a simple server application that - sends back the messages it receives. + \brief Show how to write a simple WebSocket server application. - 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. + 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 - like the following screenshot. + as shown in the following screenshot: - \image echoclient-html-example.png Screenshot of the HTML version of Echo - Client example + \image echoclient-html-example.png WebSocket Echo HTML Client - \sa {Echo Client Example} + Otherwise use the \l {WebSocket Echo Client} to connect to the server. + + \sa {WebSocket Echo Client} */ |