forked from RedhawkSDR/Documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mainch10.html
410 lines (374 loc) · 21.3 KB
/
mainch10.html
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html >
<head><title>10 The Runtime Environment in Brief</title>
<meta http-equiv="Content-Type" content="text/html; charset="utf-8"">
<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)">
<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)">
<!-- html,2,next,javascript,charset="utf-8" -->
<meta name="src" content="main.tex">
<link rel="stylesheet" type="text/css" href="main.css">
<script type="text/javascript" src="scripts/shCore.js"></script>
<script type="text/javascript" src="scripts/shBrushCpp.js"></script>
<script type="text/javascript" src="scripts/shBrushJava.js"></script>
<script type="text/javascript" src="scripts/shBrushPython.js"></script>
<script type="text/javascript" src="scripts/shBrushBash.js"></script>
<script type="text/javascript" src="scripts/shBrushXml.js"></script>
<link href="styles/shCore.css" rel="stylesheet" type="text/css" />
<link href="styles/shThemeDefault.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
SyntaxHighlighter.all()
</script>
</head><body
>
<link rel="icon" type="image/png" href="images/RedHawk_Logo16x.gif">
<script>
function f() {
document.getElementById('main_content_wrap').focus();
}
if (window.addEventListener) {
window.addEventListener("load", f, false);
} else if (window.attachEvent) {
window.attachEvent("onload", f);
}
</script>
<div class="header">
<ul class="navbar">
<li><a class="logo-small" href="index.html"><img src="images/RedHawk_Logo_ALT_B_121px.png"/></a></li> <li><a href="index.html">Home</a></li>
<li><a href="gettingstarted/main.html">Getting Started</a></li>
<li><a class="active" href="main.html">Documentation</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="community.html">Community</a></li>
</ul>
<div class="pattern right"></div>
<a id="forkme_banner" href="https://github.com/redhawksdr">View on GitHub</a>
<noscript><div class ="NoScript">WARNING: JAVASCRIPT is not enabled. JAVASCRIPT is required for viewing code snippets.</div></noscript>
</div>
<!-- Custom MAIN CONTENT -->
<div id="main_content_wrap" tabindex="0" class="outer">
<section id="main_content" class="inner">
<!--l. 1--><div class="crosslinks"><p class="noindent">[<a
href="mainch11.html" >next</a>] [<a
href="mainch9.html" >prev</a>] [<a
href="mainch9.html#tailmainch9.html" >prev-tail</a>] [<a
href="#tailmainch10.html">tail</a>] [<a
href="main.html#mainch10.html" >up</a>] </p></div>
<h2 class="chapterHead"><span class="titlemark">Chapter 10</span><br /><a
id="x12-18400010"></a>The Runtime Environment in Brief</h2>
<h3 class="sectionHead"><span class="titlemark">10.1 </span> <a
id="x12-18500010.1"></a>Introduction</h3>
<!--l. 6--><p class="noindent" >The REDHAWK runtime environment provides a mechanism for managing the life cycle
(creation/teardown/initialization) of <a
href="mainli2.html#glo:component">Components</a> as well as the interconnection of deployed
<a
href="mainli2.html#glo:component">Components</a>. A full discussion of the REDHAWK runtime environment is outside the scope of this
introductory tutorial but can be found in <a
href="mainch11.html#x13-18800011">Chapter 11</a>.
<!--l. 10--><p class="noindent" >The primary goal of the runtime environment is to support the necessary infrastructure to deploy
and manage interconnected <a
href="mainli2.html#glo:component">Components</a> as a running <a
href="mainli2.html#glo:application">Application</a>.
<!--l. 12--><p class="noindent" >The runtime environment is personified by two binaries, a <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> program and a <a
href="mainli2.html#glo:devicemanager">Device
Manager</a> program. The <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> program hosts an instance of a <span
class="ectt-1200">DomainManager </span>class as
well as supporting objects (<a
href="mainli2.html#glo:applicationfactory">Application Factory</a>, <a
href="mainli2.html#glo:application">Application</a>, <a
href="mainli2.html#glo:filemanager">File Manager</a>). The <a
href="mainli2.html#glo:devicemanager">Device Manager</a>
program hosts an instance of a <span
class="ectt-1200">DeviceManager </span>object and an instance of a File System. The only
reason why the major classes making up these programs are imported is because their <a
href="mainap11.html#api">API</a> is
remotely available, so a user can arbitrarily interact with these objects. Irrespective of their <a
href="mainap11.html#api">API</a>,
these objects will exclusively reside in either the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> or <a
href="mainli2.html#glo:devicemanager">Device Manager</a>
programs.
<!--l. 18--><p class="noindent" >A single REDHAWK system instance will have one <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and an arbitrary number of
<a
href="mainli2.html#glo:devicemanager">Device Managers</a>. The <a
href="mainli2.html#glo:domainmanager">Domain Manager</a>’s role is as a central bookkeeper as well as a single point
where <a
href="mainli2.html#glo:application">Applications</a> can be deployed or torn down. A <a
href="mainli2.html#glo:devicemanager">Device Manager</a> is present in each host in
the REDHAWK network area; in a purely processing context, there would be a single
<a
href="mainli2.html#glo:devicemanager">Device Manager</a> in each computer that is intended to host running <a
href="mainli2.html#glo:component">Components</a>. Each
<a
href="mainli2.html#glo:devicemanager">Device Manager</a> will have associated with it a set of <a
href="mainli2.html#glo:device">Devices</a> that act as proxies for
whatever hardware is running on the computer; in a purely processing context, there is a
single <a
href="mainli2.html#glo:device">Device</a> proxy describing the microprocessor for each hardware platform <a
href="mainli2.html#glo:devicemanager">Device
Manager</a>.
<!--l. 23--><p class="noindent" >The <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> program:
<ul class="itemize1">
<li class="itemize">receives an <a
href="mainap11.html#xml">XML</a> file describing a <a
href="mainli2.html#glo:waveformapplication">Waveform</a> that is to be deployed.
</li>
<li class="itemize">scans all running <a
href="mainli2.html#glo:device">Devices</a> on all <a
href="mainli2.html#glo:devicemanager">Device Managers</a> for a suitable place to deploy the
<a
href="mainli2.html#glo:component">Components</a> making up the <a
href="mainli2.html#glo:waveformapplication">Waveform</a>.
</li>
<li class="itemize">uses the <a
href="mainli2.html#glo:filemanager">File Manager</a> / File System to copy whatever files are necessary to run the
<a
href="mainli2.html#glo:component">Components</a> to the target <a
href="mainli2.html#glo:devicemanager">Device Managers</a>.
</li>
<li class="itemize">remotely invokes the <a
href="mainli2.html#glo:component">Component</a> processes.
</li>
<li class="itemize">interconnects <a
href="mainli2.html#glo:component">Components</a> over the network.
</li>
<li class="itemize">tears down <a
href="mainli2.html#glo:application">Applications</a> appropriately.</li></ul>
<!--l. 35--><p class="noindent" >
<h4 class="subsectionHead"><span class="titlemark">10.1.1 </span> <a
id="x12-18600010.1.1"></a>Launching a Domain</h4>
<!--l. 38--><p class="noindent" >If REDHAWK was installed from <a
href="mainap11.html#rpm">RPM</a>, a <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and <a
href="mainli2.html#glo:devicemanager">Device Manager</a> are ready for
immediate use on the <span
class="ectt-1200">localhost</span>. To run using a default <a
href="mainli2.html#glo:domain">Domain</a> in the <a
href="mainap11.html#ide">IDE</a>, follow these
steps:
<!--l. 41--><p class="noindent" >
<ol class="enumerate1" >
<li
class="enumerate" id="x12-186002x1">In the <a
href="mainap11.html#sca"><span
class="ecbx-1200">SCA</span></a> <span
class="ecbx-1200">Explorer </span>view (by default on the right-side of the window) right-click
the <span
class="ecbx-1200">Target </span><a
href="mainap11.html#sdr"><span
class="ecbx-1200">SDR</span></a> element and select <span
class="ecbx-1200">Launch...</span>, as seen in <a
href="#x12-186003r1">Figure 10.1</a>.
<!--l. 44--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
><a
id="x12-186003r1"></a> <img
src="images/NodesAndDevices/StartDomain.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.1: </td><td
class="content">Launching a Domain</td></tr></table><!--tex4ht:label?: x12-186003r1 -->
<!--l. 49--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
</li>
<li
class="enumerate" id="x12-186005x2">In the <a
href="mainli2.html#glo:devicemanager"><span
class="ecbx-1200">Device Manager</span></a> section, select <span
class="ecbx-1200">DevMgr_</span><span
class="ecbi-1200">hostname</span>, as seen in <a
href="#x12-186008r2">Figure
10.2</a>
</li>
<li
class="enumerate" id="x12-186007x3">Select <span
class="ecbx-1200">OK</span></li></ol>
<!--l. 59--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
>
<a
id="x12-186008r2"></a>
<!--l. 61--><p class="noindent" ><img
src="images/NodesAndDevices/SelectDevMgr.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.2: </td><td
class="content">Device Manager Selection</td></tr></table><!--tex4ht:label?: x12-186008r2 -->
<!--l. 64--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
<!--l. 66--><p class="noindent" >This will launch both a <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and a <a
href="mainli2.html#glo:devicemanager">Device Manager</a> that manages a single <a
href="mainap11.html#gpp">GPP</a>
<a
href="mainli2.html#glo:device">Device</a>. The output from both the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and <a
href="mainli2.html#glo:devicemanager">Device Manager</a> will be visible in the
<span
class="ecbx-1200">Console </span>view. If this view is not visible select <span
class="ecbx-1200">Window </span><span
class="cmmi-12">> </span><span
class="ecbx-1200">Show View </span><span
class="cmmi-12">> </span><span
class="ecbx-1200">Console</span>. These
processes can be stopped using the red square <span
class="ecbx-1200">stop </span>button. One can switch between
the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and <a
href="mainli2.html#glo:devicemanager">Device Manager</a> consoles using the console switcher button
(it looks like a small computer monitor with an arrow next to it), as seen in <a
href="#x12-186009r3">Figure
10.3</a>.
<!--l. 72--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
>
<a
id="x12-186009r3"></a>
<!--l. 74--><p class="noindent" ><img
src="images/switch_console.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.3: </td><td
class="content">Location of console switcher</td></tr></table><!--tex4ht:label?: x12-186009r3 -->
<!--l. 77--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
<!--l. 79--><p class="noindent" >A <a
href="mainli2.html#glo:domain">Domain</a> connection called <span
class="ecbx-1200">REDHAWK_DEV </span>in the <a
href="mainap11.html#sca"><span
class="ecbx-1200">SCA</span></a> <span
class="ecbx-1200">Explorer </span>view should be visible,
as seen in <a
href="#x12-186010r4">Figure 10.4</a>. Its state should be <span
class="ecbx-1200">CONNECTED </span>and there should be no errors.
A <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> process and a <a
href="mainli2.html#glo:devicemanager">Device Manager</a> process should now exist on the
host.
<!--l. 83--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
>
<a
id="x12-186010r4"></a>
<!--l. 85--><p class="noindent" ><img
src="images/running_domain.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.4: </td><td
class="content"><a
href="mainli2.html#glo:domain">Domain</a> connections shown on <a
href="mainap11.html#ide">IDE</a></td></tr></table><!--tex4ht:label?: x12-186010r4 -->
<!--l. 88--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
<h4 class="subsectionHead"><span class="titlemark">10.1.2 </span> <a
id="x12-18700010.1.2"></a>Shutting Down the Domain</h4>
<!--l. 94--><p class="noindent" >Under normal circumstances, the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and <a
href="mainli2.html#glo:devicemanager">Device Manager</a> would remain running
indefinitely; these programs are designed to remain running for extended periods of time as
different parts of the overall <a
href="mainli2.html#glo:domain">Domain</a> (e.g., <a
href="mainli2.html#glo:devicemanager">Device Managers</a>, <a
href="mainli2.html#glo:application">Applications</a>, and files on <span
class="ectt-1200">$SDRROOT</span>)
come and go. However, for the purpose of this tutorial, the process for shutting down a running
<a
href="mainli2.html#glo:domain">Domain</a> is discussed. To cleanly shutdown, it is best to disconnect the <a
href="mainli2.html#glo:domain">Domain</a> and stop the
processes that have been started.
<!--l. 98--><p class="noindent" >
<ol class="enumerate1" >
<li
class="enumerate" id="x12-187002x1">In the <a
href="mainap11.html#sca"><span
class="ecbx-1200">SCA</span></a> <span
class="ecbx-1200">Explorer </span>view right-click the <span
class="ecbx-1200">REDHAWK_DEV </span><a
href="mainli2.html#glo:domain">Domain</a> and select
<span
class="ecbx-1200">Disconnect</span>, as seen in <a
href="#x12-187013r5">Figure 10.5</a>
</li>
<li
class="enumerate" id="x12-187004x2">In the <span
class="ecbx-1200">Console </span>view, select the <a
href="mainli2.html#glo:devicemanager">Device Manager</a> Console from the console button
(looks like a computer monitor), as seen in <a
href="#x12-186009r3">Figure 10.3</a>.
</li>
<li
class="enumerate" id="x12-187006x3">Click the red square to stop the <a
href="mainli2.html#glo:devicemanager">Device Manager</a>, as seen in <a
href="#x12-187014r6">Figure 10.6</a>.
</li>
<li
class="enumerate" id="x12-187008x4">In the <span
class="ecbx-1200">Console </span>view, select the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> console from the console button
(looks like a computer monitor), as seen in <a
href="#x12-186009r3">Figure 10.3</a>.
</li>
<li
class="enumerate" id="x12-187010x5">Click the red square to stop the <a
href="mainli2.html#glo:domainmanager">Domain Manager</a>
</li>
<li
class="enumerate" id="x12-187012x6">Select <span
class="ecbx-1200">File </span><span
class="cmmi-12">> </span><span
class="ecbx-1200">Exit</span></li></ol>
<!--l. 107--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
>
<a
id="x12-187013r5"></a>
<!--l. 109--><p class="noindent" ><img
src="images/RuntimeEnvironmentInDepth/domain_disconnect.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.5: </td><td
class="content">Disconnect From Domain</td></tr></table><!--tex4ht:label?: x12-187013r5 -->
<!--l. 112--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
<!--l. 114--><p class="noindent" ><hr class="figure"><div class="figure"
><table class="figure"><tr class="figure"><td class="figure"
>
<a
id="x12-187014r6"></a>
<!--l. 116--><p class="noindent" ><img
src="images/RuntimeEnvironmentInDepth/stop_doms.png" alt="PIC"
>
<br /> <table class="caption"
><tr style="vertical-align:baseline;" class="caption"><td class="id">Figure 10.6: </td><td
class="content">Red Square stop button</td></tr></table><!--tex4ht:label?: x12-187014r6 -->
<!--l. 119--><p class="noindent" ></td></tr></table></div><hr class="endfigure">
<!--l. 121--><p class="noindent" >The <a
href="mainli2.html#glo:domainmanager">Domain Manager</a> and <a
href="mainli2.html#glo:devicemanager">Device Manager</a> processes should no longer exist on the host. The
<a
href="mainli2.html#glo:domain">Domain</a> entry will remain in the <a
href="mainap11.html#sca"><span
class="ecbx-1200">SCA</span></a> <span
class="ecbx-1200">Explorer </span>view with a <span
class="ecbx-1200">DISCONNECTED </span>state
indicating that the <a
href="mainli2.html#glo:domain">Domain</a> is no longer visible. This decoupling of the running <a
href="mainli2.html#glo:domain">Domain</a> from the
environment is there to allow the <a
href="mainap11.html#sca">SCA</a> Explorer to interact with an arbitrary number
of <a
href="mainli2.html#glo:domain">Domains</a> on a network where each <a
href="mainli2.html#glo:domain">Domain</a>’s life cycle is outside the control of the
<a
href="mainap11.html#ide">IDE</a>.
<!--l. 1--><div class="crosslinks"><p class="noindent">[<a
href="mainch11.html" >next</a>] [<a
href="mainch9.html" >prev</a>] [<a
href="mainch9.html#tailmainch9.html" >prev-tail</a>] [<a
href="mainch10.html" >front</a>] [<a
href="main.html#mainch10.html" >up</a>] </p></div>
<!--l. 1--><p class="noindent" ><a
id="tailmainch10.html"></a>
<div class=license>
<hr>
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/deed.en_US"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/80x15.png" /></a><br /><span xmlns:dct="http:// purl.org/dc/terms/" property="dct:title">REDHAWK Documentation</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/deed.en_US">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
</div></section></div>
</body></html>