diff options
Diffstat (limited to 'examples/websockets/doc/echoclient.qdoc')
| -rw-r--r-- | examples/websockets/doc/echoclient.qdoc | 73 |
1 files changed, 19 insertions, 54 deletions
diff --git a/examples/websockets/doc/echoclient.qdoc b/examples/websockets/doc/echoclient.qdoc index 654a3d6..871a916 100644 --- a/examples/websockets/doc/echoclient.qdoc +++ b/examples/websockets/doc/echoclient.qdoc @@ -1,61 +1,26 @@ -/**************************************************************************** -** -** 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 echoclient - \title Echo Client Example + \title WebSocket Echo Client + \examplecategory {Networking} \ingroup qtwebsockets-examples - \brief Describes how to use the WebSocket API for creating a simple echo client. + \brief Show how to write a simple WebSocket client application. - The Echo Client Example shows how to use the WebSocket API to create a simple - echo client. + The Echo Client shows how to use the \l {Qt WebSockets}{WebSocket} + API to send a message to a server and process whatever response the + server returns - in this case, simply reporting the response. - \sa {Echo Server Example} + The client by default opens a WebSocket connection to a server listening + on local port 1234. When the connection attempt is successful, the client + will send a message to the server and print out whatever response the + server sends. The client then closes the connection. + + \image echoclient-console-example.webp WebSocket Echo Console Client + + For the sake of illustration, we use the \l {WebSocket Echo Server}, whose + reply is simply the message that was sent. + + \sa {WebSocket Echo Server} */ |