diff options
Diffstat (limited to 'examples/websockets/doc/simplechat.qdoc')
| -rw-r--r-- | examples/websockets/doc/simplechat.qdoc | 74 |
1 files changed, 20 insertions, 54 deletions
diff --git a/examples/websockets/doc/simplechat.qdoc b/examples/websockets/doc/simplechat.qdoc index bb3d845..a89ab4b 100644 --- a/examples/websockets/doc/simplechat.qdoc +++ b/examples/websockets/doc/simplechat.qdoc @@ -1,61 +1,27 @@ -/**************************************************************************** -** -** 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 simplechat - \title Simple Chat Example + \title Simple WebSocket Chat + \examplecategory {Networking} \ingroup qtwebsockets-examples - \brief Shows how to use the QWebSocket and QWebSocketServer classes - for creating a minimalistic chat application over the WebSocket protocol. + \brief A minimal chat application using the WebSocket protocol. - The Simple Chat Example shows how to use the QWebSocket and QWebSocketServer - classes to create a minimalistic chat application over the WebSocket protocol. + This application shows how to use the QWebSocket and QWebSocketServer + classes to create a minimalist chat application over the WebSocket protocol. + The example is a server that allows multiple clients to connect to it to send + and receive messages. + + By default it listens at localhost port 1234. It keeps track of all clients + that are connected to it, and each time one of the clients sends a message to + the server, the message is forwarded to all other clients. When a client + disconnects, it is removed from the list of clients. + + \image simplechat-html-example.webp Simple WebSocket Chat HTML Client + + There is also an HTML-client that is used to connect to and disconnect from + the server, query about the connection, send messages, and view all the + messages sent by other clients. */ |