在线文档教程

megaco_udp

megaco_udp

模块

megaco_udp

模块摘要

接口模块连接到Megaco / H.248的UDP传输协议。

描述

该模块包含Megaco / H.248的UDP / IP版本传输协议的公共接口。

输出

start_transport() -> {ok, TransportRef}

类型

该功能用于启动UDP / IP传输服务。使用exit(TransportRef,Reason)停止运输服务。

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

类型

此函数用于打开UDP/IP套接字。

module选项使用户可以提供自己的回叫模块。的功能receive_message/4process_received_message/4该模块的接收到新的消息时被调用(哪一个取决于该消息的大小;小- RECEIVE_MESSAGE,大- process_received_message)。默认值是megaco

close(Handle, Msg) -> ok

类型

此函数用于关闭活动的UDP套接字。

socket(Handle) -> Socket

类型

该函数用于将socket_handle()转换为inet_socket()。inet_socket()是一个普通套接字,请参阅inet模块以获取更多信息。

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

类型

从传输手柄创建发送手柄。发送句柄旨在供megaco_udp:send_message / 2使用。

send_message(SendHandle, Msg) -> ok

类型

在套接字上发送消息。发送句柄由megaco_udp:create_send_handle / 3获取。如果消息已成功发送,则增加NumOutMessages和NumOutOctets计数器。如果发送失败,NumErrors计数器不会递增。这是在megaco应用程序的其他地方完成的。

block(Handle) -> ok

类型

停止接收套接字上的传入消息。

unblock(Handle) -> ok

类型

再次开始接收来自套接字的传入消息。

upgrade_receive_handle(ControlPid, NewHandle) -> ok

类型

更新控制过程的接收句柄(例如,在更改协议版本后)。

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

类型

Retreive UDP相关(SNMP)统计计数器。

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

类型

重置所有TCP相关(SNMP)统计计数器。