chatserver.h Example File

chatserver-cpp/chatserver.h
 /****************************************************************************
 **
 ** Copyright (C) 2016 Klar��lvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Milian Wolff <milian.wolff@kdab.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$
 **
 ****************************************************************************/

 #ifndef CHATSERVER_H
 #define CHATSERVER_H

 #include <QObject>
 #include <QStringList>

 class QTimer;

 class ChatServer : public QObject
 {
     Q_OBJECT

     Q_PROPERTY(QStringList userList READ userList NOTIFY userListChanged)

 public:
     explicit ChatServer(QObject *parent = nullptr);
     virtual ~ChatServer();

 public:
     //a user logs in with the given username
     Q_INVOKABLE bool login(const QString &userName);

     //the user logs out, will be removed from userlist immediately
     Q_INVOKABLE bool logout(const QString &userName);

     //a user sends a message to all other users
     Q_INVOKABLE bool sendMessage(const QString &user, const QString &msg);

     //response of the keep alive signal from a client.
     // This is used to detect disconnects.
     Q_INVOKABLE void keepAliveResponse(const QString &user);

     QStringList userList() const;

 protected slots:
     void sendKeepAlive();
     void checkKeepAliveResponses();

 signals:
     void newMessage(QString time, QString user, QString msg);
     void keepAlive();
     void userListChanged();
     void userCountChanged();

 private:
     QStringList m_userList;
     QStringList m_stillAliveUsers;
     QTimer *m_keepAliveCheckTimer;
 };

 #endif // CHATSERVER_H