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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtAddOn.JsonStream module of the Qt.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qremoteprocessbackendfactory.h"
#include "qremoteprocessbackend.h"
#include "qremoteprotocol.h"
QT_BEGIN_NAMESPACE_PROCESSMANAGER
const int kRemoteTimerInterval = 1000;
/*!
\class QRemoteProcessBackendFactory
\brief The QRemoteProcessBackendFactory class creates QRemoteProcessBackend objects
\inmodule QtProcessManager
The QRemoteProcessBackendFactory communicates with a remote process to control
other, child processes.
The factory communicates with the remote process by sending and receiving
JSON-formated messages. The remote process should respond to the following
commands:
\table
\header
\li Command
\li Action
\row
\li \c{{ "command": "start", "id": NUM, "info": PROCESSINFO }}
\li Start a new process running. The \b{token} attribute will
be used to refer to this process in the future.
\row
\li \c{{ "command": "stop", "id": NUM, "timeout": NUM }}
\li Stop the remote process with an optional timeout.
The remote process should be sent a SIGTERM, followed by
a SIGKILL after 'timeout' milliseconds
\row
\li \c{{ "command": "set", "id": NUM, "key": STRING, "value": NUM }}
\li Set a process key/value pair. Currently the \b{key} can be
either "priority" or "oomAdjustment".
\row
\li \c{{ "command": "write", "id": NUM, "data": STRING }}
\li Write a data string to the remote process. We assume that the
data string is a valid local 8 bit string.
\row
\li \c{{ "command": "memory", "restricted": bool }}
\li Let the remote process know if memory use is restricted.
\endtable
The following are events that are sent by the remote process
to the QRemoteProcessBackendFactory:
\table
\header
\li Event
\li Description
\row
\li \c{{ "event": "started", "id": NUM, "pid": NUM }}
\li This process has started. This maps to the QProcess::started()
signal, but also includes the PID of the new process. This should
be the first event returned after a \b{start} command
\row
\li \c{{ "event": "finished", "id": NUM, "exitCode": NUM, "exitStatus": NUM }}
\li The process has exited. This is the last event returned for a given
process number.
\row
\li \c{{ "event": "error", "id": NUM, "error": NUM }}
\li The process has an error that maps to QProcess::ProcessError
\row
\li \c{{ "event": "stateChanged", "id": NUM, "state": NUM }}
\li The process has an event that maps to a QProcess::ProcessState change.
\row
\li \c{{ "event": "output", "id": NUM, "stdout": STRING, "stderr": STRING }}
\li The process has written data to stdout and/or stderr.
\endtable
*/
/*!
Construct a QRemoteProcessBackendFactory with optional \a parent.
*/
QRemoteProcessBackendFactory::QRemoteProcessBackendFactory(QObject *parent)
: QProcessBackendFactory(parent)
, m_idCount(100)
{
}
/*!
Destroy this and child objects.
*/
QRemoteProcessBackendFactory::~QRemoteProcessBackendFactory()
{
foreach (QRemoteProcessBackend *backend, m_backendMap)
backend->factoryDestroyed();
}
/*!
Construct a QRemoteProcessBackend from a ProcessInfo \a info record with \a parent.
*/
QProcessBackend * QRemoteProcessBackendFactory::create(const QProcessInfo& info, QObject *parent)
{
int id = m_idCount++;
QRemoteProcessBackend *backend = new QRemoteProcessBackend(info, this, id, parent);
m_backendMap.insert(id, backend);
return backend;
}
/*!
Idle CPU is available. Send the message over the wire
*/
void QRemoteProcessBackendFactory::idleCpuAvailable()
{
QJsonObject object;
object.insert(QRemoteProtocol::remote(), QRemoteProtocol::idlecpuavailable());
send(object);
}
/*!
Tell the remote factory that memory is restricted and space should be freed up.
*/
void QRemoteProcessBackendFactory::handleMemoryRestrictionChange()
{
QJsonObject object;
object.insert(QRemoteProtocol::remote(), QRemoteProtocol::memory());
object.insert(QRemoteProtocol::restricted(), m_memoryRestricted);
send(object);
}
/*!
Return a list of local internal processes. This is separate from the
remote internal process list, which comes from the remote host.
You should override this function is a subclass if your subclass is
holding a process object
*/
QPidList QRemoteProcessBackendFactory::localInternalProcesses() const
{
return QPidList();
}
/*!
Handle first connection to the remote process.
This function should be called by subclasses.
*/
void QRemoteProcessBackendFactory::handleConnected()
{
handleMemoryRestrictionChange(); // Sends command="memory" message
}
/*!
Receive a remote \a message and dispatch it to the correct recipient.
Call this function from your subclass to properly dispatch messages.
*/
void QRemoteProcessBackendFactory::receive(const QJsonObject& message)
{
// qDebug() << Q_FUNC_INFO << message;
QString remote = message.value(QRemoteProtocol::remote()).toString();
if (remote == QRemoteProtocol::idlecpurequested())
setIdleCpuRequest(message.value(QRemoteProtocol::request()).toBool());
else if (remote == QRemoteProtocol::internalprocesses()) {
QPidList plist = localInternalProcesses() +
arrayToPidList(message.value(QRemoteProtocol::processes()).toArray());
qSort(plist);
setInternalProcesses(plist);
}
else if (remote == QRemoteProtocol::internalprocesserror()) {
int value = (int) message.value(QRemoteProtocol::processError()).toDouble();
emit internalProcessError(static_cast<QProcess::ProcessError>(value));
}
else {
int id = message.value(QLatin1String("id")).toDouble();
if (m_backendMap.contains(id))
m_backendMap.value(id)->receive(message);
}
}
/*!
\fn bool QRemoteProcessBackendFactory::send(const QJsonObject& message)
Send a \a message to the remote process. This method must be implemented in a
child process. Return true if the message can be sent.
*/
/*!
\internal
*/
void QRemoteProcessBackendFactory::backendDestroyed(int id)
{
if (m_backendMap.remove(id) != 1)
qCritical("Missing remote process backend");
}
#include "moc_qremoteprocessbackendfactory.cpp"
QT_END_NAMESPACE_PROCESSMANAGER
|
