查看源代码 megaco_tcp (megaco v4.7)

-type counter() ::
          medGwyGatewayNumInMessages | medGwyGatewayNumInOctets | medGwyGatewayNumOutMessages |
          medGwyGatewayNumOutOctets | medGwyGatewayNumErrors.

定义此传输处理的不同计数器。

handle()

-opaque handle()

表示 TPKT 连接的不透明数据类型。

函数

block(Handle)

-spec block(Handle) -> ok when Handle :: handle().

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

close(Handle)

-spec close(Handle) -> ok when Handle :: handle().

此函数用于关闭活动的 TPKT 连接。

connect(TransportRef, Opts)

-spec connect(TransportRef, Opts) -> {ok, Handle, ControlPid} | {error, Reason}
                 when
                     TransportRef :: pid() | RegName,
                     RegName :: atom(),
                     Opts :: [Option],
                     Option ::
                         {inet_backend, default | inet | socket} |
                         {host, Host} |
                         {port, PortNum} |
                         {options, list()} |
                         {receive_handle, term()} |
                         {module, atom()},
                     Host :: inet:socket_address() | inet:hostname(),
                     PortNum :: inet:port_number(),
                     Handle :: handle(),
                     ControlPid :: pid(),
                     Reason :: term().

此函数用于打开 TPKT 连接。

module - 此选项使用户可以提供自己的回调模块。当收到新消息时，将调用此模块的 receive_message/4 或 process_received_message/4 函数。调用哪个函数取决于消息的大小：
- small - receive_message
- large - process_received_message
默认值为 megaco。
inet_backend - 选择 inet 后端。
此选项可以使用不同的 inet 后端（'default'、'inet' 或 'socket'）。
默认值为 default（系统默认值）。

get_stats()

-spec get_stats() -> {ok, TotalStats} | {error, Reason}
                   when
                       TotalStats :: [{Handle, [{Counter, integer()}]}],
                       Handle :: handle(),
                       Counter :: counter(),
                       Reason :: term().

获取所有已知连接的所有计数器值。

get_stats(Handle)

-spec get_stats(Handle) -> {ok, Stats} | {error, Reason}
                   when
                       Handle :: handle(),
                       Stats :: [{Counter, integer()}],
                       Counter :: counter(),
                       Reason :: term().

获取给定（连接）句柄的所有计数器值。

get_stats(Handle, Counter)

-spec get_stats(Handle, Counter) -> {ok, integer()} | {error, Reason}
                   when Handle :: handle(), Counter :: counter(), Reason :: term().

获取特定计数器的值。

listen(TransportRef, Options)

-spec listen(TransportRef, Options) -> ok
                when
                    TransportRef :: pid() | RegName,
                    RegName :: atom(),
                    Options :: [Option],
                    Option ::
                        {inet_backend, default | inet | socket} |
                        {port, inet:port_number()} |
                        {options, list()} |
                        {receive_handle, term()}.

此函数用于为 TCP/IP 启动新的 TPKT 监听套接字。选项列表包含套接字定义。

inet_backend - 选择 inet 后端。
此选项可以使用不同的 inet 后端（'default'、'inet' 或 'socket'）。
默认值为 default（系统默认值）。

reset_stats()

-spec reset_stats() -> megaco:void().

重置所有连接的所有计数器。

reset_stats(Handle)

-spec reset_stats(Handle) -> megaco:void() when Handle :: handle().

重置给定连接的所有计数器。

send_message(Handle, Msg)

-spec send_message(Handle, Msg) -> ok when Handle :: handle(), Msg :: binary() | iolist().

在 TPKT 连接上发送消息。

socket(Handle)

-spec socket(Handle) -> Socket when Handle :: handle(), Socket :: inet:socket().

此函数用于将套接字 handle() 转换为 inet socket()。

start_transport()

-spec start_transport() -> {ok, TransportRef} when TransportRef :: pid().

此函数用于启动 TCP/IP 传输服务。使用 exit(TransportRef, Reason) 停止传输服务。

unblock(Handle)

-spec unblock(Handle) -> ok when Handle :: handle().

再次开始从套接字接收传入消息。

upgrade_receive_handle(ControlPid, NewRecvHandle)

-spec upgrade_receive_handle(ControlPid, NewRecvHandle) -> ok
                                when ControlPid :: pid(), NewRecvHandle :: term().

升级控制进程的接收句柄（例如，在更改协议版本之后）。