megaco_codec_mstone1(3erl)

🎀 megaco_codec_mstone1 — Erlang Module Definition (3erl) · megaco manual 🎀

✨ NAME ✨

megaco_codec_mstone1 is literally the simple megaco codec-based performance tool module. It’s giving benchmark era, no cap. 💅

🦋 DESCRIPTION 🦋

Okay so this module implements the mstone1 tool — a simple megaco codec-based performance tool. Main character energy fr fr.

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

🚨 Important vibe check: this module is not included in the runtime part of the application. Periodt.

🌸 EXPORTS 🌸

🫶 start() / start(MessagePackage) / start(MessagePackage, Factor)

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. For every supported codec config, Factor processes are started — and Factor defaults to 1. Each process encodes and decodes its messages. The number of messages processed in total (for all processes) is the mstone value. 🎀

🧚 start_flex() / start_flex(MessagePackage) / start_flex(MessagePackage, Factor)

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() / start_only_drv(MessagePackage) / start_only_drv(MessagePackage, Factor)

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() / start_no_drv(MessagePackage) / start_no_drv(MessagePackage, Factor)

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. 🌈

---

💖 Cute little source/version/date sign-off: this page is from Ericsson AB, it’s from megaco 4.4.3, and it’s tagged megaco_codec_mstone1(3erl) — the original footer doesn’t actually show a date, so we’re not making one up, bestie. Bye, slay! 💅✨