diff options
Diffstat (limited to 'examples/websockets/doc/qmlwebsocketclient.qdoc')
| -rw-r--r-- | examples/websockets/doc/qmlwebsocketclient.qdoc | 77 |
1 files changed, 26 insertions, 51 deletions
diff --git a/examples/websockets/doc/qmlwebsocketclient.qdoc b/examples/websockets/doc/qmlwebsocketclient.qdoc index d5ac310..b3da626 100644 --- a/examples/websockets/doc/qmlwebsocketclient.qdoc +++ b/examples/websockets/doc/qmlwebsocketclient.qdoc @@ -1,56 +1,31 @@ -/**************************************************************************** -** -** 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 qmlwebsocketclient - \title QML WebSocket Client Example + \title QML WebSocket Client + \examplecategory {Networking} \ingroup qtwebsockets-examples - \brief Explains how to program a QML WebSocket client example. + \brief Explains how to write a QML WebSocket client example. + + The QML WebSocket Client example creates a secure and an + insecure \l {Qt WebSockets}{WebSocket} connection to an echo + server, using the QML API, and alternates between opening + connections and closing them. Every time a connection has + been opened, it sends a message. + + \image qmlwebsocketclient-example.webp QML WebSocket Client GUI + + This example opens a window with a welcome message. Every time + the window is clicked on, it alternates between opening and + closing two connections to an external echo server. The echo + server used is at ws.ifelse.io, and an Internet connection is + necessary for the example to work. Also TLS must be enabled for + the secure connection to work. When the connection is opened or + closed, the statusChanged signal is handled by the + onStatusChanged handler. Every time the socket is opened, a + message is sent, and every time the socket is closed, a message + is logged in the window. In addition, there is an + onTextMessageReceived handler that logs to the window the + messages received from the server. */ |