megaco_udp(3erl)

🎀 NAME 🎀

okay so bestie, welcome to megaco_udp(3erl) — the Erlang Module Definition page for megaco_udp 💖. This is the one about the UDP/IP transport protocol interface for Megaco/H.248, and we’re getting into every single detail, no cap ✨.

---

🌈 DESCRIPTION 🌈

This module contains the public interface to the UDP/IP version transport protocol for Megaco/H.248. It’s giving “official doorway to the UDP/IP transport” energy, and we’re obsessed 💅.

---

💅 EXPORTS 💅

start_transport() -> {ok, TransportRef}

Types:

TransportRef = pid()

This function is used for starting the UDP/IP transport service. To stop the transport service, use exit(TransportRef, Reason) — that’s the stop button, periodt 🫶.

open(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason}

Types:

TransportRef = pid() | regname()
OptionList = [option()]
option() = {port, integer()} | {options, list()} |
{receive_handle, receive_handle()} | {module, atom()} |
{inet_backend, default | inet | socket}
Handle = socket_handle()
receive_handle() = term()
ControlPid = pid()
Reason = term()

This function is used to open an UDP/IP socket. The allowed option tuples are exactly these, bestie:

• {port, integer()}
• {options, list()}
• {receive_handle, receive_handle()}
• {module, atom()}
• {inet_backend, default | inet | socket}

module option details

The module option makes it possible for the user to provide their own callback module. The functions receive_message/4 or process_received_message/4 of this module is called when a new message is received. Which one depends on the size of the message:

• small: receive_message
• large: process_received_message

Default value is megaco. Slay ✨.

close(Handle, Msg) -> ok

Types:

Handle = socket_handle()
Msg

This function is used for closing an active UDP socket. Bye socket, hope you had a cute day 🦋.

socket(Handle) -> Socket

Types:

Handle = socket_handle()
Socket = inet_socket()

This function is used to convert a socket_handle() to a inet_socket(). inet_socket() is a plain socket, see the inet module for more info 👑.

create_send_handle(Handle, Host, Port) -> send_handle()

Types:

Handle = socket_handle()
Host = {A,B,C,D} | string()
Port = integer()

Creates a send handle from a transport handle. The send handle is intended to be used by megaco_udp:send_message/2. It’s giving “make the send handle so the send can happen” 💌.

send_message(SendHandle, Msg) -> ok

Types:

SendHandle = send_handle()
Message = binary() | iolist()

Sends a message on a socket. The send handle is obtained by megaco_udp:create_send_handle/3. Increments the NumOutMessages and NumOutOctets counters if message successfully sent. In case of a failure to send, the NumErrors counter is not incremented. This is done elsewhere in the megaco app. Important detail, don’t forget it 🫡.

block(Handle) -> ok

Types:

Handle = socket_handle()

Stop receiving incoming messages on the socket. The socket is on do-not-disturb mode 💀.

unblock(Handle) -> ok

Types:

Handle = socket_handle()

Starting to receive incoming messages from the socket again. DND off, bestie, messages are back 🌸.

upgrade_receive_handle(ControlPid, NewHandle) -> ok

Types:

ControlPid = pid()
NewHandle = receive_handle()
receive_handle() = term()

Update the receive handle of the control process (e.g. after having changed protocol version). Glow-up for the receive handle ✨.

get_stats() / get_stats(SendHandle) / get_stats(SendHandle, Counter)

Signatures:

get_stats() -> {ok, TotalStats} | {error, Reason}
get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason}
get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason}

Types:

TotalStats = [total_stats()]
total_stats() = {send_handle(), [stats()]}
SendHandle = send_handle()
SendHandleStats = [stats()]
Counter = udp_stats_counter()
CounterStats = integer()
stats() = {udp_stats_counter(), integer()}
tcp_stats_counter() = medGwyGatewayNumInMessages |
medGwyGatewayNumInOctets | medGwyGatewayNumOutMessages |
medGwyGatewayNumOutOctets | medGwyGatewayNumErrors
Reason = term()

Retreive the UDP related (SNMP) statistics counters. Yes, the page spells it “Retreive”; I’m keeping the detail and lovingly side-eyeing it 😭. Also yes, it literally says tcp_stats_counter() in this UDP page’s type block — copying that exactly, no editing, periodt 💅.

reset_stats() / reset_stats(SendHandle)

Signatures:

reset_stats() -> void()
reset_stats(SendHandle) -> void()

Types:

SendHandle = send_handle()

Reset all TCP related (SNMP) statistics counters. Yep, the page says TCP here too — on the UDP page — so we keep that exact wording, bestie 💀🔥.

---

That’s the page, periodt 💅

Footer vibes: Ericsson AB, version megaco 4.4.3, page megaco_udp(3erl). No date is printed on the footer, so I’m not inventing one 🫶.