aboutsummaryrefslogtreecommitdiffstats
path: root/src/ipc/ipcserver.cpp
blob: d303787566bdd48d58f802202367ff56b9fa2107 (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QmlLive tool.
**
** $QT_BEGIN_LICENSE:GPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/

#include "ipcserver.h"
#include "ipcconnection.h"

#ifdef QMLLIVE_IPC_DEBUG
#define DEBUG qDebug()
#else
#define DEBUG if (0) qDebug()
#endif

/*!
 * \class IpcServer
 * \brief The IpcServer listens on a port and creates an IpcConnection for an incoming
 * connection.
 * \inmodule ipc
 *
 * The IPC server receives a method call from the client an notifies the user through
 * the IpcServer::received signal.
 *
 * \code{.cpp}
 * m_server = new IpcServer(this);
 * connect(m_server, &IpcServer::received, this, &MyHandler::handleCall);
 * m_server->listen(10234);
 *
 * ...
 *
 * MyHandler::handleCall(const QString& method, const QByteArray& contnt) {
 *   if (method == "echo(QString)") {
 *     QString text;
 *     QDataStream in(content);
 *     in >> text;
 *     qDebug() << "call received: " << method << ": " << text;
 *   }
 * }
 * \endcode
 */

/*!
 * \brief Standard constructor using \a parent as parent object
 */
IpcServer::IpcServer(QObject *parent)
    : QObject(parent)
    , m_server(new QTcpServer(this))
{
    connect(m_server, &QTcpServer::newConnection, this, &IpcServer::newConnection);
}

/*!
 * \brief listens to incomong connections on \a port
 */
void IpcServer::listen(int port)
{
    DEBUG << "IpcServer::listen: " << port;
    m_server->listen(QHostAddress::Any, port);
}

/*!
 * \brief Creates a IpcConnection on incoming connection
 */
void IpcServer::newConnection()
{
    DEBUG << "IpcServer::newConnection";
    if (m_server->hasPendingConnections()) {
        QTcpSocket *socket = m_server->nextPendingConnection();
        emit clientConnected(socket->peerAddress());
        emit clientConnected(socket);
        IpcConnection *connection = new IpcConnection(socket, this);
        connect(connection, &IpcConnection::connectionClosed, this, &IpcServer::onConnectionClosed);
        connect(connection, &IpcConnection::received, this, &IpcServer::received);
    }
}


void IpcServer::onConnectionClosed()
{
    IpcConnection *connection = qobject_cast<IpcConnection*>(sender());

    emit clientDisconnected(connection->socket()->peerAddress());
    emit clientDisconnected(connection->socket());

    if (connection->parent() == this)
        delete connection;
}

/*!
 * Sets the maximal nuber of pending connections to \a num
 */
void IpcServer::setMaxConnections(int num)
{
    m_server->setMaxPendingConnections(num);
}


/*!
 * \fn void IpcServer::received(const QString& method, const QByteArray& content)
 * \brief signals a IPC call has arrived
 *
 * A IPC call requesting \a method and using \a content a the parameters for the method
 */

/*!
 * \fn void IpcServer::clientConnected(const QHostAddress& address)
 *
 * Called when a new client connection is established, providing the \a address
 */

/*!
 * \fn void IpcServer::clientConnected(QTcpSocket *socket)
 *
 * * Called when a new client connection is established, providing the \a socket
 */

/*!
 * \fn void IpcServer::clientDisconnected(QTcpSocket *socket)
 *
 * * Called when an existing client connection is dropped, providing the \a socket
 */

/*!
 * \fn void IpcServer::clientDisconnected(const QHostAddress& address)
 *
 * Called when an existing client connection is dropped, providing the \a address
 */