Merge pull request #1844 from jrw972/monterey
[ACE_TAO.git] / TAO / performance-tests / Pluggable / README
blob624e77d2cbeb3c06684ac72541d1ab107f9cbf96
3 The tests in this directory time the latency contributed by
4 various parts of the ORB, but mostly the emphasis is on the
5 contribution due to the pluggable protocols code.  So far, the
6 output is only to the screen, and is created using the ACE
7 Timeprobe class. At various points in the ORB code and in this
8 test code, an ACE Timeprobe is inserted. When this point is
9 passed in the execution, a timestamp is taken and added to a
10 table. When the test finishes, the relative times are output,
11 START being the first, or zero, entry, and the following
12 values are the offset in microseconds. Each value has a label
13 associated with it when the timeprobes are inserted.
15 There are currently two tests. Either or both can be executed
16 in a single run by using the appropriate command line options
17 listed below. Since we are not interested in the time spent
18 in the actual operation, but only in the framework overhead,
19 we have code for a oneway and a twoway request that neither
20 pass nor return any values.
22 Usage:
23 The client command line options are:
24         [-v]            run only the 2-way void test
25         [-o]            run only the 1-way void test
26         [-d]            increment the TAO debug level
27         [-n loopcount]  # of executions (defaults to 1)
28         [-f <filename>] read IOR from <filename>
29         [-k <string>]   read IOR from command line
30         [-x]            shut down server when finished
32 NOTE: Unless the server is shut down,  it will not
33 display its timeprobe information. If the client runs
34 twice, for example, and then the server is shut down,
35 it will then display the results from both runs.
37 The server command line options are:
38         [-d]            increment the TAO debug level
39         [-o] <filename> write the IOR to <filename>
42 NOTE: To display the timeprobe info, ACE must be built with
43 the macro ACE_COMPILE_TIMEPROBES defined somewhere, usually
44 in config.h. Otherwise the individual timeprobe macros are
45 ignored.