aboutsummaryrefslogtreecommitdiffstats
path: root/lib/megaco/doc/src/megaco_codec_mstone2.xml
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
committerErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
commit84adefa331c4159d432d22840663c38f155cd4c1 (patch)
treebff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/megaco/doc/src/megaco_codec_mstone2.xml
downloadotp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz
otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2
otp-84adefa331c4159d432d22840663c38f155cd4c1.zip
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/megaco/doc/src/megaco_codec_mstone2.xml')
-rw-r--r--lib/megaco/doc/src/megaco_codec_mstone2.xml66
1 files changed, 66 insertions, 0 deletions
diff --git a/lib/megaco/doc/src/megaco_codec_mstone2.xml b/lib/megaco/doc/src/megaco_codec_mstone2.xml
new file mode 100644
index 0000000000..778e125a75
--- /dev/null
+++ b/lib/megaco/doc/src/megaco_codec_mstone2.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="latin1" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2002</year><year>2009</year>
+ <holder>Ericsson AB. All Rights Reserved.</holder>
+ </copyright>
+ <legalnotice>
+ The contents of this file are subject to the Erlang Public License,
+ Version 1.1, (the "License"); you may not use this file except in
+ compliance with the License. You should have received a copy of the
+ Erlang Public License along with this software. If not, it can be
+ retrieved online at http://www.erlang.org/.
+
+ Software distributed under the License is distributed on an "AS IS"
+ basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+ the License for the specific language governing rights and limitations
+ under the License.
+
+ </legalnotice>
+
+ <title>megaco_codec_mstone2</title>
+ <prepared>Micael Karlberg</prepared>
+ <responsible>Micael Karlberg</responsible>
+ <docno></docno>
+ <approved>Micael Karlberg</approved>
+ <checked></checked>
+ <date>2009-05-27</date>
+ <rev>%VSN%</rev>
+ <file>megaco_codec_mstone2.xml</file>
+ </header>
+ <module>megaco_codec_mstone2</module>
+ <modulesummary>This module implements a simple megaco codec-based performance tool.</modulesummary>
+ <description>
+ <p>This module implements the <em>mstone2</em> tool,
+ a simple megaco codec-based performance tool.</p>
+ <p>The results, the mstone value(s), are written to stdout.</p>
+ <p><em>Note</em> that this module is <em>not</em> included in the runtime part of
+ the application.</p>
+ </description>
+
+ <funcs>
+ <func>
+ <name>start() -> void()</name>
+ <name>start(MessagePackage) -> void()</name>
+ <fsummary></fsummary>
+ <type>
+ <v>MessagePackage = message_package()</v>
+ <v>message_package() = atom()</v>
+ </type>
+ <desc>
+ <p>This function starts the <em>mstone2</em> performance test with all codec configs.
+ Processes are created dynamically. Each process make <em>one</em> run
+ through their messages (decoding and encoding messages) and then exits.
+ When one process exits, a new is created with the same codec config and set
+ of messages. </p>
+ <p>The number of messages processed in total (for all processes) is the mstone value.</p>
+ </desc>
+ </func>
+
+ </funcs>
+
+</erlref>
+