Search documentation of megaco

# megaco_codec_mstone1 (megaco v4.9.1)

Copy Markdown View Source

This module implements a simple megaco codec-based performance tool.

This module implements the mstone1 tool, a simple megaco codec-based performance tool.

The results, the mstone value(s), are written to stdout.

Note that this module is not included in the runtime part of the application.

## Summary

### Functions

start()

Equivalent to `start/2`.

start([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor)

start(MessagePackage, Factor)

This function starts the mstone1 performance test with all codec configs. `Factor` (defaults to `1`) processes are started for every supported codec config.

start_flex()

Equivalent to `start_flex/2`.

start_flex([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor)

start_flex(MessagePackage, Factor)

This function starts the mstone1 performance test with only the flex codec configs (i.e. `pretty` and `compact` with `flex`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

start_no_drv()

Equivalent to `start_no_drv/2`.

start_no_drv([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor)

start_no_drv(MessagePackage, Factor)

This function starts the mstone1 performance test with codec configs not using any drivers (i.e. `pretty` and `compact` without `flex`, `ber` and `per` without `driver` and `erlang` without `compressed`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

start_only_drv()

Equivalent to `start_only_drv/2`.

start_only_drv/1

start_no_drv([MessagePackage, RunTime, Factor])

start_only_drv(MessagePackage, Factor)

This function starts the mstone1 performance test with only the driver using codec configs (i.e. `pretty` and `compact` with `flex`, and `ber` and `per` with `driver` and `erlang` with `compressed`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

## Functions

# start()

Equivalent to `start/2`.

# start([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor):

    erl -s megaco_codec_mstone1 start time_test 1 1

# start(MessagePackage, Factor)

    -spec start(RunTime, Factor) -> ok when RunTime :: pos_integer(), Factor :: default | pos_integer();
               (MessagePackage, Factor) -> ok when MessagePackage :: atom(), Factor :: pos_integer().

This function starts the mstone1 performance test with all codec configs. `Factor` (defaults to `1`) processes are started for every supported codec config.

Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

# start_flex()

Equivalent to `start_flex/2`.

# start_flex([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor):

    erl -s megaco_codec_mstone1 start_flex time_test 1 1

# start_flex(MessagePackage, Factor)

    -spec start_flex(MessagePackage, Factor) -> ok when MessagePackage :: atom(), Factor :: pos_integer().

This function starts the mstone1 performance test with only the flex codec configs (i.e. `pretty` and `compact` with `flex`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

# start_no_drv()

Equivalent to `start_no_drv/2`.

# start_no_drv([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor):

    erl -s megaco_codec_mstone1 start_no_drv time_test 1 1

# start_no_drv(MessagePackage, Factor)

    -spec start_no_drv(MessagePackage, Factor) -> ok when MessagePackage :: atom(), Factor :: pos_integer().

This function starts the mstone1 performance test with codec configs not using any drivers (i.e. `pretty` and `compact` without `flex`, `ber` and `per` without `driver` and `erlang` without `compressed`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.

# start_only_drv()

Equivalent to `start_only_drv/2`.

# start_only_drv/1

start_no_drv([MessagePackage, RunTime, Factor])

This function is intended to be called from the mstone1 script, which uses the '-s' arguments to run the function (argument order; message package, run time (in minutes in the example) and factor):

    erl -s megaco_codec_mstone1 start_no_drv time_test 1 1

# start_only_drv(MessagePackage, Factor)

    -spec start_only_drv(MessagePackage, Factor) -> ok
                            when MessagePackage :: atom(), Factor :: pos_integer().

This function starts the mstone1 performance test with only the driver using codec configs (i.e. `pretty` and `compact` with `flex`, and `ber` and `per` with `driver` and `erlang` with `compressed`). The same number of processes are started as when running the standard test (using the `start/0,1` function). Each process encodes and decodes their messages. The number of messages processed in total (for all processes) is the mstone value.