Merge pull request #2309 from mitza-oci/warnings
[ACE_TAO.git] / TAO / performance-tests / Throughput / README
blob770d64341d7f8ff900e952e766f716cbfd2ca5d6
1 /**
5 @page Throughput Performance Test README File
7         This test tries to estimate the maximum throughput (in bytes
8 per second) that the ORB can achieve.  The test sends octet sequences
9 of increasing sizes to a remote consumer, and measures both the time
10 it takes to receive the data as well as the time required to send it.
11 A single twoway operation is used to ensure that the data is properly
12 flushed.
14         Please do not extend this test to deal with other data types,
15 configurations, etc.  If you need to just create a new test.  In the
16 past we had multi-purpose tests like that, they were hard to maintain,
17 and the results were hard to interpret.  Furthermore, the test is
18 purposely simple so its output can be parsed via nightly scripts and
19 plotted in a graph.   More importantly, the throughput for raw data
20 and the marshaling time are completely different things and should be
21 measured with different tools.
23         To run the test use the run_test.pl script:
25 $ ./run_test.pl
27         the script returns 0 if the test was successful, and prints
28 out the performance numbers.