summaryrefslogtreecommitdiffstats
path: root/src/declarative/declarativesocketlauncher.cpp
blob: f6dad6098bacb5e4dda013a25a5095d3928b56d0 (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
155
156
157
158
159
160
161
162
163
164
165
166
167
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** 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, Nokia gives you certain additional
** rights. These rights are described in the Nokia 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.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "declarativesocketlauncher.h"

QT_BEGIN_NAMESPACE_PROCESSMANAGER

/*!
  \qmlclass PmLauncher DeclarativeSocketLauncher
  \brief The PmLauncher class encapsulates ways of creating and tracking processes
         suitable for QtQml programs.

   The PmLauncher class is used to create a standalone program for launching
   and tracking child processes.  Other programs can connect to the PmLauncher using
   a JsonStream-formatted socket connection.

   Here is an example of a simple launcher instantiation:

   \qml
   import QtQuick 2.0
   import Test 1.0

   PmLauncher {
       id: socket_launcher

       factories: [
           StandardProcessBackendFactory {
               id: gdbFactory
               matchDelegate: KeyMatchDelegate { key: "gdb" }
               rewriteDelegate: GdbRewriteDelegate {}
           },
           StandardProcessBackendFactory {
               id: standardFactory
           }
       ]

       JsonUIDRangeAuthority {
           id: rangeAuthority
           minimum: 0
           maximum: 1000
       }

       Component.onCompleted: {
           socket_launcher.listen("/tmp/socket_launcher", rangeAuthority);
       }
   }
   \endqml

   Note that the PmLauncher object has been configured with two factories, the first
   of which rewrites any ProcessInfo objects containing a "gdb" attribute to
   use the gdb server.  The PmLauncher object also has a JsonUIDRangeAuthority object
   which is assigned to the internal JsonServer.
*/

/*!
  \qmlproperty list<ProcessBackendFactory> PmLauncher::factories
  List of ProcessBackendFactory objects.

  The order of the list is important - when launching a new
  process each factory in turn will be given a chance.
 */

/*!
  \qmlproperty list<Object> PmLauncher::children
  Generic child objects of this PmLauncher - allows extra objects like Authorities
  to be instantiated under this class.
 */

/*!
  \class DeclarativeSocketLauncher
  \brief The DeclarativeSocketLauncher class is a lightweight wrapper around a SocketLauncher object.
*/

/*!
  Create a DeclarativeSocketLauncher object with optional parent \a parent.
 */

DeclarativeSocketLauncher::DeclarativeSocketLauncher(QObject *parent)
    : SocketLauncher(parent)
{
}

/*!
  \internal
*/

void DeclarativeSocketLauncher::classBegin()
{
}

/*!
  \internal
*/

void DeclarativeSocketLauncher::componentComplete()
{
}

/*!
  \internal
*/

void DeclarativeSocketLauncher::append_factory(QQmlListProperty<ProcessBackendFactory> *list,
                                               ProcessBackendFactory *factory)
{
    DeclarativeSocketLauncher *launcher = static_cast<DeclarativeSocketLauncher *>(list->object);
    if (factory && launcher)
        launcher->addFactory(factory);
}

/*!
  \internal
*/

QQmlListProperty<ProcessBackendFactory> DeclarativeSocketLauncher::factories()
{
    return QQmlListProperty<ProcessBackendFactory>(this, NULL, append_factory);
}

/*!
  \internal
*/

QQmlListProperty<QObject> DeclarativeSocketLauncher::children()
{
    return QQmlListProperty<QObject>(this, m_children);
}

#include "moc_declarativesocketlauncher.cpp"

QT_END_NAMESPACE_PROCESSMANAGER