Merge pull request #1551 from DOCGroup/plm_jira_333
[ACE_TAO.git] / TAO / examples / Persistent_Grid / README
blob35b652a46b18f7b74677f6bbcec3b5f09861c78c
1 This example shows how to store the state of CORBA servants in
2 persistent memory.  The example is a variation of the Grid example in
3 $TAO_ROOT/examples/Simple/grid.
5 The server hosts the Grid servant.  A client sets some values in the
6 grid.  These values are written out by the server in to a
7 memory-mapped file, at which point the server shuts down.  A new
8 server is then started, which reads from the same memory-mapped file.
9 Another client (named persistent_client) then reads and prints the
10 values from the locations where the original client stored the values.
12 server:
13 -------
15 server [-d debug] -o <ior_output_file> -m <memory_pool>
17 Options:
18 -------
19 -o    Outputs the ior to the file
20       The ior is the reference using which the client can interact with
21       the target server object.
22 -m    Name of the memory pool.
25 When the server is started, you should see as the first line of output
26 something that looks like
28         iiop:1.0//danzon.cs.wustl.edu:10015/P35ad159600081a38/child_poa/server
29         (-ORBobjrefstyle url)
31         IOR:000000000000001649444c3a43756269745...
32         (-ORBobjrefstyle ior)
34 client:
35 -------
37 client [-d] [-x] [-f <Server_ior_file>] [-k file://<ior_output_file>]
38        [-w] [-h] [-v]
40 Options:
41 -------
42 -d    Debug flag
43 -x    Tells the server to shutdown at the end of the test.
44 -f    Reads the server ior from the file
45 -k    IOR or The IOR can also be given in the format like file://[file.ior]
46       with the full path
48 -w    Width of the grid
49 -h    Height of the grid
50 -v    Value that needs to be the starting point for storage. The value
51       that is stored will be this value + location id.
53 persistent_client:
54 -----------------
55 persistent_client [-d] [-x] [-f <Server_ior_file>] [-k file://<ior_output_file>]
56        [-w] [-h] [-v]
58 Options:
59 -------
60 -d    Debug flag
61 -x    Tells the server to shutdown at the end of the test.
62 -f    Reads the server ior from the file
63 -k    IOR or The IOR can also be given in the format like file://[file.ior]
64       with the full path
66 -w    Width of the grid from where the values are to be read
67 -h    Height of the grid from the where the values are to be read
69 run_test.pl:
70 ------------
72 This perl script runs the server then the client. It shuts down the
73 server and restarts the server. It then starts the persistent_client
74 to read the values from the memory mapped file.