# megaco_codec_mstone1

###
Module

megaco_codec_mstone1

###
Module Summary

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

###
Description

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.

###
Exports

####
start() -> void()

####
start(MessagePackage) -> void()

####
start(MessagePackage, Factor) -> void()

### Types

MessagePackage = message_package()
message_package() = atom()
Factor() = integer() > 0

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() -> void()

####
start_flex(MessagePackage) -> void()

####
start_flex(MessagePackage, Factor) -> void()

### Types

MessagePackage = message_package()
message_package() = atom()
Factor() = integer() > 0

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_only_drv() -> void()

####
start_only_drv(MessagePackage) -> void()

####
start_only_drv(MessagePackage, Factor) -> void()

### Types

MessagePackage = message_package()
message_package() = atom()
Factor() = integer() > 0

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.

####
start_no_drv() -> void()

####
start_no_drv(MessagePackage) -> void()

####
start_no_drv(MessagePackage, Factor) -> void()

### Types

MessagePackage = message_package()
message_package() = atom()
Factor() = integer() > 0

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.