Merge pull request #2303 from jwillemsen/jwi-803
[ACE_TAO.git] / TAO / examples / Simple / time / README
blob494eb13611e9c4180f5b0130a4e97f1e711a1491
3 This is a simple CORBA example that has an object (Time) with two
4 methods: one that returns the current time of day and another that
5 shuts down the server.  There are clients programs written in both C++
6 and Java to access the simple Time service.  The Java client uses
7 JACE's GetOpt class to parse the command line arguments.  See
9   http://www.cs.wustl.edu/~schmidt/JACE.html
10   http://ace.cs.wustl.edu/cvsweb/ace-latest.cgi/ACE_wrappers/java/JACE/Misc/GetOpt.java
12 for more details.
14 run_test.pl : This is a perl script to run the server and client as :
15 ------------
16               server -o ior_file
17               client -f ior_file
19 This perl script runs the server and client and shuts down the server
20 when it is done.
22 Passing the Server IOR to Clients:
23 ---------------------------------
25 To keep this example simple, the server advertises its IOR in the
26 following manner - The server program writes its server object's IOR
27 to a ior_file.  Later on, the client reads this IOR from the specified
28 ior_file and uses the <string_to_object> method to obtain a reference
29 to the server object.
31 For this mechanism to work, the file must be readable and writable. If
32 it doesn't exist, a new file is created by the server.  Moreover, the
33 file path must be accessible to both the client and server.
35 If the client and server are on different machine, then there must be
36 a shared directory accessible by both. On UNIX system's this is
37 typically done via the NFS mount command.  On Windows, the 'explorer'
38 application provides an option to share drives.
40 In general if no such file sharing option is available, then using the
41 the Naming Service mechanism is the only alternative, as descrbed by
42 the -n option below.
44 server:
45 -------
47 server [-nd] [-o <ior_output_file>]
49 Options:
50 -------
51 -o    Outputs the server ior to the file
53 When the server is started, you should see as the first line of output
54 something that looks like
55         iiop:1.0//danzon.cs.wustl.edu:10015/P35ad159600081a38/child_poa/server
56         (-ORBobjrefstyle url)
58         IOR:000000000000001649444c3a43756269745...
59         (-ORBobjrefstyle ior)
61 The -o option makes it easier to run from a script because the ior
62 passing is done through the <ior_output_file>.
64 -d    Debug flag
65 -n    Use the naming service
67 Using -d turns on debugging messages.  This option is additive, i.e.,
68 the more -d options provided, the more debugging you can get.  At the
69 moment, only 2 levels of debugging are implemented, and more than 2 -d
70 options are ignored.
72 client:
73 -------
75 client [-d] [-x] [-f <Server_ior_file>] [-n iterations] [-k ior]
77 Options:
78 -------
79 -d    Debug flag
80 -x    Tells the server to shutdown at the end of the test.
81 -f    Reads the server ior from the file
82 -n    Use the naming service
83 -k    IOR or The IOR can also be given in the format like file://[file.ior]
84       with the full path
86 You can either cut and paste the IOR from the server to the client
87 (with the -k option), or have the client read the IOR from a file
88 using the -f option. (This file is produced using the -o option with the
89 server.)