summaryrefslogtreecommitdiff
path: root/CIAO/docs/ConfigValues.html
blob: 70ade5ca68d8a97233b527d0676d8b49d08623df (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
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
<!-- $Id$ -->
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html> <head>
<title>ConfigValues Index</title>
</head>

<body>

<h1>Index of ConfigValues</h1>

<font size="+1" color="red">This page is currently a placeholder for
all the configuration values we will support when creating various CCM
deployment mechanisms, such as ComponentServers and Containers.  The
ConfigValues listed here are currently only partially supported in
CIAO. <p>

Note from self:  There are discrepancy in this document.  Most
significantly, (RT)ComponentServer's don't get their ConfigValues
directly from that passed in thru
ServerActivator::create_component_server but rather, using some sort
of pre-defined command line flags.
</font>

<h2>ComponentServer</h2>
The <code>ConfigValues</code> for a <code>ComponentServer</code> are
passed in via <code>ServerActivator::create_component_server</code>
operation.  CIAO accepts the following feature names:<p>

<table border="3" spacing="2" cellpadding="3">
  <tr>
    <th>FeatureName</th>
    <th>type</th>
    <th>Requirement</th>
    <th>Remarks</th>
  </tr>
  <tr>
    <td>CIAO-svcconf-id</td>
    <td>string</td>
    <td>
        Optional
    </td>
    <td>
        Specify the canonical svc.conf id.  This id should only serve
        as a hint for the deployment framework in determining the
        actual svc.conf file used to start up the component server.
        Currently, CIAO's ServerActivator maintains a set of svc.conf
        files and use this id value to map to the exact svc.conf file
        name.
    </td>
  </tr>
  <tr>
    <td>CIAO-ORB[option]</td>
    <td>string</td>
    <td>
        Optional
    </td>
    <td>
        Specify an ORB option that you want to pass to the
        ComponentServer ORB.
    </td>
  </tr>
</table>

<h2>RTComponentServer (Real-time ComponentServer)</h2>

Like a regular <code>ComponentServer</code>, the
<code>ConfigValues</code> for a <code>RTComponentServer</code> are
passed in via <code>ServerActivator::create_component_server</code>
operation.  On top of the <code>ConfigValues</code> accepted by the
regular <code>ComponentServer</code>, a real-time ComponentServer also
accepts the following feature names:<p>

<table border="3" spacing="2" cellpadding="3">
  <tr>
    <th>FeatureName</th>
    <th>type</th>
    <th>Requirement</th>
    <th>Remarks</th>
  </tr>
  <tr>
    <td>CIAO-rtcad-filename</td>
    <td>string</td>
    <td>
        Optional
    </td>
    <td>
        Specify the filename of RTCAD extension XML file.
        The component server will invoke the XML parser and translate
        the content of the file into the following two ConfigValues
        (CIAO-RTresources and CIAO-RTPolicySets) to
        RTComponentServer implementation.
    </td>
  </tr>
  <tr>
    <td>CIAO-RTresources</td>
    <td><code>CIAO::RTConfiguration::RTORB_Resources_Info</code></td>
    <td>
        Optional
    </td>
    <td>
        <code>CIAO::RTConfiguration::RTORB_Resources_Info</code> as
        defined in
        <code>$CIAO_ROOT/tools/XML_Helpers/RTConfiguration.idl</code>
        defines the system wise resources an RT ORB should allocate.
        These resources then can be used to define the RT policies in
        the RTPolicySet described subsequently.
    </td>
  </tr>
  <tr>
    <td>CIAO-RTPolicySets</td>
    <td><code>CIAO::RTConfiguration::Policy_Sets</code></td>
    <td>
        Optional
    </td>
    <td>
        <code>CIAO::RTConfiguration::Policy_Sets</code>, also
        defined in
        <code>$CIAO_ROOT/tools/XML_Helpers/RTConfiguration.idl</code>,
        defines a list of policy sets, which are named sequences of
        policies.  These policies often refer to the global resources
        defined in the previous CIAO-RTresource via names.  Likewise,
        an <b>RT-container</b> also specifies the RTPolicySet its POA
        uses via the name defined here.
    </td>
  </tr>
</table>

<h2>Container</h2>
The <code>ConfigValues</code> for a <code>Container</code> are
passed in via <code>ComponentServer::create_container</code>
operation.  CIAO accepts the following feature names:<p>

<table border="3" spacing="2" cellpadding="3">
  <tr>
    <th>FeatureName</th>
    <th>type</th>
    <th>Requirement</th>
    <th>Remarks</th>
  </tr>
  <tr>
    <td>
        CIAO-Container-Type
    </td>
    <td>
        <code>string</code>
    </td>
    <td>
        currently not supported.
    </td>
    <td>
        Possible value: <code>session</code>, <code>rt-session</code>,
        <code>unclassified</code>, <code>rt-unclassified</code>.
    </td>
  </tr>

  <tr>
    <td>
        CIAO-POAPolicies
    </td>
    <td>
        <code>CORBA::PolicyList</code>
    </td>
    <td>
        Currently not supported.
    </td>
    <td>
        Must not conflict with CIAO-Container-Type setting.
        (Certain containers assume several POA policies.)
    </td>
  </tr>

  <tr>
    <td>
        CIAO-RTPolicySet
    </td>
    <td>
        <code>string</code>
    </td>
    <td>
        Optional
    </td>
    <td>
        Name, as defined in RTCompoenentServer's CIAO-RTPolicySets, of
        the PolicySet this container uses.
    </td>
  </tr>
</table>


<h2>CCMHome</h2>
The <code>ConfigValues</code> for a <code>CCMHome</code> are
passed in via <code>Container::install_home</code>
operation.  CIAO accepts the following feature names:<p>

<table border="3" spacing="2" cellpadding="3">
  <tr>
    <th>FeatureName</th>
    <th>type</th>
    <th>Requirement</th>
    <th>Remarks</th>
  </tr>
  <tr>
    <td>CIAO-executor-path</td>
    <td><code>string</code></td>
    <td>
        REQUIRED
    </td>
    <td>
        This string value specifies the location of the executor DLL.
        In the future, we should use UUIDs to identify the component
        executors and query the ComponentInstallation interface for
        the actual location of the DLL.
    </td>
  </tr>
  <tr>
    <td>CIAO-executor-entrypt</td>
    <td><code>string</code></td>
    <td>
        REQUIRED
    </td>
    <td>
        This string value specifies the entry point of the executor
        DLL.  It points to a factory function for the component executor.
    </td>
  </tr>
  <tr>
    <td>CIAO-servant-path</td>
    <td><code>string</code></td>
    <td>
        REQUIRED
    </td>
    <td>
        This string value specifies the location of the servant DLL.
        In the future, we should use UUIDs to identify the component
        servants and query the ComponentInstallation interface for
        the actual location of the DLL. <p>

        Servant are part of the Container framework and we can use
        type checking to ensure servant and container match with each
        other.
    </td>
  </tr>
  <tr>
    <td>CIAO-executor-entrypt</td>
    <td><code>string</code></td>
    <td>
        REQUIRED
    </td>
    <td>
        This string value specifies the entry point of the servant
        DLL.  It points to a factory function for the compnent servant.
    </td>
  </tr>
</table>

<!--
  <tr>
    <td>
        a
    </td>
    <td>
        b
    </td>
    <td>
        c
    </td>
  </tr>
-->
<!--#include virtual="/~nanbor/signature.html" -->
</body> </html>