Merge pull request #1844 from jrw972/monterey
[ACE_TAO.git] / TAO / orbsvcs / IFR_Service / README
blobb8f182c0c5498c2c665c62f6fa0b2d730f8aa686
3 Interface Repository -------
5 Required libraries (in addition to ACE and TAO):
6         ACE_ROOT/TAO/tao/IFR_CLient/TAO_IFR_CLient.(lib-ext)
7         ACE_ROOT/TAO/tao/TypeCodeFactory/TAO_TypeCodeFactory.(lib-ext)
8         ACE_ROOT/TAO/tao/PortableServer/TAO_PortableServer.(lib-ext)
9         ACE_ROOT/TAO/tao/IORTable/TAO_IORTable.(lib-ext)
10         ACE_ROOT/TAO/orbsvcs/orbsvcs/TAO_Svc_Utils.(lib-ext)
12 Executable name is tao_ifr.
14 Command line options are:
16  -p             Makes the Interface Repository persistent.
18  -b <filename>  Overrides the default filename used for
19                 persistent storage. The default filename
20                 is "ifr_default_backing_store".
22  -m             Enables read/write locking of IFR calls.
23                 If the IFR is started up with
24                 multithreading enabled - for example if
25                 a service config file is used that specifies
26                 thread-per-connection - this option should be
27                 used. Note that if ACE_HAS_THREADS is not
28                 defined, this option will be ignored.
30  -r             Uses win32 registry for the database. Not
31                 available with persistence. If -p is on
32                 the command line, this option is ignored.
33                 If the platform is not win32, an error
34                 message is output.
36  -o <filename>  Overrides the default filename used for
37                 outputting the Interface Repository IOR.
38                 The default filename is "if_repo.ior".
40 Test code for the Interface Repository can be found in
41 ACE_ROOT/TAO/orbsvcs/tests/InterfaceRepo.
45 tao_ifr ------
47 This is the executable that administers the IFR. Calling
48 tao_ifr <IDL filename> will add the contents of the IDL
49 file to the repository. Calling tao_ifr -r <IDL filename>
50 will remove the contents of the IDL file from the repository.
51 tao_ifr requires all the libraries that are required by
52 the IFR service, plus the IFR_Service executable itself.
53 Test code for tao_ifr can be found in
54 ACE_ROOT/TAO/orbsvcs/tests/InterfaceRepo/Application_Test.
56 tao_ifr can also handle the -ORBxxx parameters. The one most
57 frequently used would probably be
59 '-ORBInitRef InterfaceRepository=file://<filename>'
61 which will enable the IFR service to be resolved by getting
62 its IOR from <filename>. By default, the IFR service stores
63 its IOR in the file 'if_repo.ior', but that can be modified
64 by starting the IFR service using the -o option (see above).
65 All -ORB options appear in the command line before any other
66 options, since the -ORB options are consumed by CORBA::ORB_init.
68 tao_ifr can process multiple IDL files in one execution. As
69 long as the filenames come after any -ORB options that may
70 be present, they may come mixed in any order with the other
71 command line options. The tao_ifr command line parser will
72 treat any option (or option pair) that doesn't begin with
73 '-' as a filename.
75 More information about the Interface Repository and tao_ifr can
76 be found in ACE_ROOT/TAO/docs/releasenotes/index.html.
79 - Jeff Parsons <parsons@cs.wustl.edu>