path: root/lib/megaco/doc/src/megaco_codec_meas.xml

<?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_meas</title>
    <prepared>Micael Karlberg</prepared>
    <responsible>Micael Karlberg</responsible>
    <docno></docno>
    <approved>Micael Karlberg</approved>
    <checked></checked>
    <date>2007-06-15</date>
    <rev>%VSN%</rev>
    <file>megaco_codec_meas.xml</file>
  </header>
  <module>megaco_codec_meas</module>
  <modulesummary>This module implements a simple megaco codec measurement tool.</modulesummary>
  <description>
    <p>This module implements a simple megaco codec measurement tool.</p>
    <p>Results are written to file (excel compatible text files) and on 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>MessagePackageRaw = message_package()</v>
        <v>message_package() = atom()</v>
      </type>
      <desc>
        <p>This function runs the measurement on all the <em>official</em> codecs;
          pretty, compact, ber, per and erlang.</p>
      </desc>
    </func>

  </funcs>

</erlref>