summaryrefslogtreecommitdiff
path: root/TAO/docs/implrepo/tao_imr.html
blob: 88b6e33000059e2b65fbe627ef5a0ccf0acf772c (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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
<html>
<!-- $Id$ -->
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=iso-8859-1">
<meta name="GENERATOR" content="Microsoft FrontPage 4.0">
<title>Implementation Repository User's Guide</title>
</head>

<body bgcolor="#FFFFFF">

<hr>

<h2>tao_imr Usage</h2>

<p>The usage of tao_imr is as follows:</p>

<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] <a href="#commands">command</a>
[command-arguments]</code></p>

<p><i>ORB_options</i> is the ORB options to be given. This is where
options like &quot;-ORBInitRef ImplRepoService=file://implrepo.ior&quot; would be placed. 
<i>command </i>is one of the supported commands like add, remove, etc. <i>command-arguments</i>
are dependent on the command used. For example, <i>add </i>will need a
server name for registration, but list does not necessarily need any arguments.</p>

<hr>

<h3><a name="examples">Examples</a></h3>
<p>There is a file in the current directory name <i>implrepo.ior</i> that
contains the IOR of the Implementation Repository. The server executable
is called <i>airplane.exe</i> and the POA name used by the object is <i>plane</i>.
The server needs the -i option to use the IMR and the IOR of the IMR. So the
command would be:</p>

<p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior add plane -c &quot;airplane.exe
-i file://implrepo.ior&quot;</code></p>

<p><code>And if you want to later remove that server from the IMR:</code></p>

<p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior remove plane</code></p>

<p>Or if you wanted to update the entry to have a working directory of
C:\airplane\.</p>

<p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior update plane -w
&quot;C:\airplane\&quot;</code></p>

<hr>

<h3><a name="commands">Commands</a></h3>

<p><i>tao_imr</i> currently supports these commands:</p>

<table border="1">
  <tr>
    <th>Command</th>
    <th>Description</th>
  </tr>
  <tr>
    <td><a href="#activate">activate</a></td>
    <td>Activates a server through the IMR</td>
  </tr>
  <tr>
    <td><a href="#add">add</a></td>
    <td>Adds a server to the server database in the IMR</td>
  </tr>
  <tr>
    <td><a href="#autostart">add</a></td>
    <td>Activates all servers that are marked AUTO_START</td>
  </tr>
  <tr>
	<td><a href="#ior">ior</a></td>
	<td>Creates a simple IOR for a registered server</td>
  </tr>
  <tr>
    <td><a href="#list">list</a></td>
    <td>Lists the details of one server or lists all the servers registered in
      the IMR</td>
  </tr>
  <tr>
    <td><a href="#remove">remove</a></td>
    <td>Removes a server from the server database in the IMR</td>
  </tr>
  <tr>
    <td><a href="#shutdown">shutdown</a></td>
    <td>Shuts down a server through the IMR</td>
  </tr>
  <tr>
    <td><a href="#update">update</a></td>
    <td>Updates information for a server in the server database in the IMR</td>
  </tr>
</table>

<hr>

<h3><a name="activate">activate</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] activate <i>name </i>[-h]</code></p>

<p>Activate a server through the Implementation Repository. The <i>name</i> is
the server (POA) name that is used to identify the server.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
</table>

<hr>

<h3><a name="add">add</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]
[-c <i>command</i>] [-w <i>working_dir</i>] [-a NORMAL|MANUAL|PER_CLIENT]</code></p>

<p>Creates a new server entry in the Implementation Repository. The <i>name</i>
must be be the name of the POA that the object resides in.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
  <tr>
    <td>-c <i>command</i></td>
    <td>Adds the command line string used to restart this server</td>
  </tr>
  <tr>
    <td>-w <i>working_dir</i></td>
    <td>Adds the working directory that is used for the server</td>
  </tr>
  <tr>
    <td>[-a NORMAL|MANUAL|PER_CLIENT|AUTO_START]</td>
	<td>Specifies the type of activation.<br>
	    NORMAL = normal activation (default)<br>
		MANUAL = only can be started manually on the command line or with tao_imr<br>
		PER_CLIENT = each client that contacts the ImplRepo will get its own activated server<br>
		AUTO_START = activated when the IMR is started or when tao_imr autostart is used</td>
  </tr>
</table>

<hr>

<h3><a name="auto_start">auto_start</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] auto_start [-h]</code></p>

<p>Activates all servers with the activation mode of AUTO_START.  It will not start new
copies if the server is already activated.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
</table>

<hr>

<h3><a name="ior">ior</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] ior <i>name</i> [-h] 
[-f <i>filename</i>]</code></p>

<p>Creates a simple IOR that can be used with the Implementation Repository. Please refer
to the <a href="usersguide.html">User's Guide</a> for more information on when to use this
command.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
  <tr>
    <td>-f <i>filename</i></td>
    <td>Outputs the IOR also to this file</td>
  </tr>
</table>

<hr>

<h3><a name="list">list</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] list [<i>name</i>]<i>
</i>[-h] [-v]</code></p>

<p>Lists all or one of the server entries in the Implementation Repository. If a
<i>name</i> is used, it will display verbose information about the server
identified by its server (POA) name.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
  <tr>
    <td>-v</td>
    <td>When listing the list of servers (no <i>name</i> specified), display
      verbose information for all servers.</td>
  </tr>
</table>

<hr>

<h3><a name="remove">remove</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]</code></p>

<p>Removes a server entry from the Implementation Repository. The <i>name</i> is
the server (POA) name that is used to identify the server.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
</table>

<hr>

<h3><a name="shutdown">shutdown</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] shutdown <i>name </i>[-h]</code></p>

<p>Shuts down a server through the Implementation Repository. The <i>name</i> is
the server (POA) name that is used to identify the server.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
</table>

<hr>

<h3><a name="update">update</a></h3>
<p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]
[-c <i>command</i>] [-w <i>working_dir</i>]</code></p>

<p><code>Update a server entry in the Implementation Repository. </code>The <i>name</i>
is the server (POA) name that is used to identify the server.</p>

<table border="1">
  <tr>
    <th>Option</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>-h</td>
    <td>Displays help for this command</td>
  </tr>
  <tr>
    <td>-c <i>command</i></td>
    <td>Changes the command line string used to restart this server</td>
  </tr>
  <tr>
    <td>-w <i>working_dir</i></td>
    <td>Changes the working directory that is used for the server</td>
  </tr>
</table>

<hr>

<p>Back to <a href="index.html">Implementation Repository</a></p>
</body>
</html>