TAO/docs/implrepo/tao_imr.html

   1 <html>
   2 <!--  -->
   3 <head>
   4 <meta http-equiv="Content-Type"
   5 content="text/html; charset=iso-8859-1">
   6 <meta name="GENERATOR" content="Microsoft FrontPage 4.0">
   7 <title>Implementation Repository User's Guide</title>
   8 </head>
   9
  10 <body bgcolor="#FFFFFF">
  11
  12 <hr>
  13
  14 <h2>tao_imr Usage</h2>
  15
  16 <p>The usage of tao_imr is as follows:</p>
  17
  18 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] <a href="#commands">command</a>
  19 [command-arguments]</code></p>
  20
  21 <p><i>ORB_options</i> is the ORB options to be given. This is where
  22 options like &quot;-ORBInitRef ImplRepoService=file://implrepo.ior&quot; would be placed.
  23 <i>command </i>is one of the supported commands like add, remove, etc. <i>command-arguments</i>
  24 are dependent on the command used. For example, <i>add </i>will need a
  25 server name for registration, but list does not necessarily need any arguments.</p>
  26
  27 <hr>
  28
  29 <h3><a name="examples">Examples</a></h3>
  30 <p>There is a file in the current directory name <i>implrepo.ior</i> that
  31 contains the IOR of the Implementation Repository. The server executable
  32 is called <i>airplane.exe</i> and the POA name used by the object is <i>plane</i>.
  33 The server needs the -i option to use the IMR and the IOR of the IMR. So the
  34 command would be:</p>
  35
  36 <p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior add plane -c &quot;airplane.exe
  37 -i file://implrepo.ior&quot;</code></p>
  38
  39 <p><code>And if you want to later remove that server from the IMR:</code></p>
  40
  41 <p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior remove plane</code></p>
  42
  43 <p>Or if you wanted to update the entry to have a working directory of
  44 C:\airplane\.</p>
  45
  46 <p><code>tao_imr -ORBInitRef ImplRepoService=file://implrepo.ior update plane -w
  47 &quot;C:\airplane\&quot;</code></p>
  48
  49 <hr>
  50
  51 <h3><a name="commands">Commands</a></h3>
  52
  53 <p><i>tao_imr</i> currently supports these commands:</p>
  54
  55 <table border="1">
  56   <tr>
  57     <th>Command</th>
  58     <th>Description</th>
  59   </tr>
  60   <tr>
  61     <td><a href="#activate">activate</a></td>
  62     <td>Activates a server through the IMR</td>
  63   </tr>
  64   <tr>
  65     <td><a href="#add">add</a></td>
  66     <td>Adds a server to the server database in the IMR</td>
  67   </tr>
  68   <tr>
  69     <td><a href="#autostart">add</a></td>
  70     <td>Activates all servers that are marked AUTO_START</td>
  71   </tr>
  72   <tr>
  73         <td><a href="#ior">ior</a></td>
  74         <td>Creates a simple IOR for a registered server</td>
  75   </tr>
  76   <tr>
  77     <td><a href="#list">list</a></td>
  78     <td>Lists the details of one server or lists all the servers registered in
  79       the IMR</td>
  80   </tr>
  81   <tr>
  82     <td><a href="#remove">remove</a></td>
  83     <td>Removes a server from the server database in the IMR</td>
  84   </tr>
  85   <tr>
  86     <td><a href="#shutdown">shutdown</a></td>
  87     <td>Shuts down a server through the IMR</td>
  88   </tr>
  89   <tr>
  90     <td><a href="#update">update</a></td>
  91     <td>Updates information for a server in the server database in the IMR</td>
  92   </tr>
  93 </table>
  94
  95 <hr>
  96
  97 <h3><a name="activate">activate</a></h3>
  98 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] activate <i>name </i>[-h]</code></p>
  99
 100 <p>Activate a server through the Implementation Repository. The <i>name</i> is
 101 the server (POA) name that is used to identify the server.</p>
 102
 103 <table border="1">
 104   <tr>
 105     <th>Option</th>
 106     <th>Description</th>
 107   </tr>
 108   <tr>
 109     <td>-h</td>
 110     <td>Displays help for this command</td>
 111   </tr>
 112 </table>
 113
 114 <hr>
 115
 116 <h3><a name="add">add</a></h3>
 117 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]
 118 [-c <i>command</i>] [-w <i>working_dir</i>] [-a NORMAL|MANUAL|PER_CLIENT]</code></p>
 119
 120 <p>Creates a new server entry in the Implementation Repository. The <i>name</i>
 121 must be be the name of the POA that the object resides in.</p>
 122
 123 <table border="1">
 124   <tr>
 125     <th>Option</th>
 126     <th>Description</th>
 127   </tr>
 128   <tr>
 129     <td>-h</td>
 130     <td>Displays help for this command</td>
 131   </tr>
 132   <tr>
 133     <td>-c <i>command</i></td>
 134     <td>Adds the command line string used to restart this server</td>
 135   </tr>
 136   <tr>
 137     <td>-w <i>working_dir</i></td>
 138     <td>Adds the working directory that is used for the server</td>
 139   </tr>
 140   <tr>
 141     <td>[-a NORMAL|MANUAL|PER_CLIENT|AUTO_START]</td>
 142         <td>Specifies the type of activation.<br>
 143             NORMAL = normal activation (default)<br>
 144                 MANUAL = only can be started manually on the command line or with tao_imr<br>
 145                 PER_CLIENT = each client that contacts the ImplRepo will get its own activated server<br>
 146                 AUTO_START = activated when the IMR is started or when tao_imr autostart is used</td>
 147   </tr>
 148 </table>
 149
 150 <hr>
 151
 152 <h3><a name="auto_start">auto_start</a></h3>
 153 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] auto_start [-h]</code></p>
 154
 155 <p>Activates all servers with the activation mode of AUTO_START.  It will not start new
 156 copies if the server is already activated.</p>
 157
 158 <table border="1">
 159   <tr>
 160     <th>Option</th>
 161     <th>Description</th>
 162   </tr>
 163   <tr>
 164     <td>-h</td>
 165     <td>Displays help for this command</td>
 166   </tr>
 167 </table>
 168
 169 <hr>
 170
 171 <h3><a name="ior">ior</a></h3>
 172 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] ior <i>name</i> [-h]
 173 [-f <i>filename</i>]</code></p>
 174
 175 <p>Creates a simple IOR that can be used with the Implementation Repository. Please refer
 176 to the <a href="usersguide.html">User's Guide</a> for more information on when to use this
 177 command.</p>
 178
 179 <table border="1">
 180   <tr>
 181     <th>Option</th>
 182     <th>Description</th>
 183   </tr>
 184   <tr>
 185     <td>-h</td>
 186     <td>Displays help for this command</td>
 187   </tr>
 188   <tr>
 189     <td>-f <i>filename</i></td>
 190     <td>Outputs the IOR also to this file</td>
 191   </tr>
 192 </table>
 193
 194 <hr>
 195
 196 <h3><a name="list">list</a></h3>
 197 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] list [<i>name</i>]<i>
 198 </i>[-h] [-v]</code></p>
 199
 200 <p>Lists all or one of the server entries in the Implementation Repository. If a
 201 <i>name</i> is used, it will display verbose information about the server
 202 identified by its server (POA) name.</p>
 203
 204 <table border="1">
 205   <tr>
 206     <th>Option</th>
 207     <th>Description</th>
 208   </tr>
 209   <tr>
 210     <td>-h</td>
 211     <td>Displays help for this command</td>
 212   </tr>
 213   <tr>
 214     <td>-v</td>
 215     <td>When listing the list of servers (no <i>name</i> specified), display
 216       verbose information for all servers.</td>
 217   </tr>
 218   <tr>
 219     <td>-a</td>
 220     <td>Filters the list of servers to include only those that are
 221     active. If the server has recently responding to a ping request
 222     within the ping interval used by the implementation repository
 223     (adjustable by passing the -v option to tao_imr_locator) then the
 224     server is considered active. If not, an attempt is made to ping
 225     the server, and if it successful, then the server is considered
 226     active. This option is only applicable if the activator is being
 227     used. Note that if there a large number of servers registered with
 228     the implementation repository it may take a long time to complete
 229     if it needs to sequentially ping the servers to determine if it is
 230     active.</td>
 231 </table>
 232
 233 <hr>
 234
 235 <h3><a name="remove">remove</a></h3>
 236 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]</code></p>
 237
 238 <p>Removes a server entry from the Implementation Repository. The <i>name</i> is
 239 the server (POA) name that is used to identify the server.</p>
 240
 241 <table border="1">
 242   <tr>
 243     <th>Option</th>
 244     <th>Description</th>
 245   </tr>
 246   <tr>
 247     <td>-h</td>
 248     <td>Displays help for this command</td>
 249   </tr>
 250 </table>
 251
 252 <hr>
 253
 254 <h3><a name="shutdown">shutdown</a></h3>
 255 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] shutdown <i>name </i>[-h]</code></p>
 256
 257 <p>Shuts down a server through the Implementation Repository. The <i>name</i> is
 258 the server (POA) name that is used to identify the server.</p>
 259
 260 <table border="1">
 261   <tr>
 262     <th>Option</th>
 263     <th>Description</th>
 264   </tr>
 265   <tr>
 266     <td>-h</td>
 267     <td>Displays help for this command</td>
 268   </tr>
 269 </table>
 270
 271 <hr>
 272
 273 <h3><a name="update">update</a></h3>
 274 <p><code><b>tao_imr </b>[<a href="../Options.html">ORB options</a>] add <i>name </i>[-h]
 275 [-c <i>command</i>] [-w <i>working_dir</i>]</code></p>
 276
 277 <p><code>Update a server entry in the Implementation Repository. </code>The <i>name</i>
 278 is the server (POA) name that is used to identify the server.</p>
 279
 280 <table border="1">
 281   <tr>
 282     <th>Option</th>
 283     <th>Description</th>
 284   </tr>
 285   <tr>
 286     <td>-h</td>
 287     <td>Displays help for this command</td>
 288   </tr>
 289   <tr>
 290     <td>-c <i>command</i></td>
 291     <td>Changes the command line string used to restart this server</td>
 292   </tr>
 293   <tr>
 294     <td>-w <i>working_dir</i></td>
 295     <td>Changes the working directory that is used for the server</td>
 296   </tr>
 297 </table>
 298
 299 <hr>
 300
 301 <p>Back to <a href="index.html">Implementation Repository</a></p>
 302 </body>
 303 </html>