summaryrefslogtreecommitdiff
path: root/examples/webchannel/chatserver-cpp/doc/src/chatserver-cpp.qdoc
blob: 0b198d26b72bf66b23a24d5d3837c837e8cfb0bd (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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/****************************************************************************
**
** Copyright (C) 2016 basysKom GmbH, author Bernd Lamecker <bernd.lamecker@basyskom.com>
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebChannel 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$
**
****************************************************************************/

/*!
    \example chatserver-cpp
    \title Qt WebChannel ChatServer Example
    \ingroup qtwebchannel-examples
    \brief A simple chat server implemented using the QWebChannel C++ API.

    \image chatserver-cpp.png

    \e{ChatServer} provides a chat service that the
    \l{Qt WebChannel ChatClient QML Example} and
    \l{Qt WebChannel ChatClient HTML Example} can connect to.

    \include examples-run.qdocinc

    \section1 Implementing a Chat Server

    The C++ application implements a QObject which provides all mechanisms required for
    a chat service.
    This object is published through a QWebChannel which uses a \l{Qt WebSockets}
    {WebSocket} as transport.

    The server provides a basic \c login method (username only, no passwords), which must be
    successfully invoked before a client is able to chat.
    After login, a client can invoke the method \c sendMessage and receive the signal \c newMessage
    to write and receive messages. Furthermore, there is a \c userList property which provides
    the names of all other connected clients.
    Additionally the server sends a \c keepAlive signal periodically to all clients. The clients
    have to respond to this signal, otherwise the client will be removed from the \c userList property.

    The example shows how basic QObject elements can be used with QWebChannel, that is signals
    (\c newMessage), slots (\c sendMessage), and properties (\c userList).

    Because this is a plain server application, separate clients are needed to
    interact with it. \l{Qt WebChannel ChatClient QML Example} and
    \l{Qt WebChannel ChatClient HTML Example} are client implementations
    compatible with this server.

*/