Interface module to TPKT transport protocol for Megaco/H.248.
This module contains the public interface to the TPKT (TCP/IP) version transport protocol for Megaco/H.248.
Functions
TransportRef = pid()
This function is used for starting the TCP/IP transport service. Use exit(TransportRef, Reason) to stop the transport service.
TransportRef = pid() | regname()
OptionListPerPort = [Option]
Option = {port, integer()} |{options, list()} |{receive_handle, term()}
This function is used for starting new TPKT listening socket for TCP/IP. The option list contains the socket definitions.
TransportRef = pid() | regname()
OptionList = [Option]
Option = {host, Ipaddr} | {port, integer()} |{options, list()} |{receive_handle, term()} |{module, atom()}
Handle = socket_handle()
ControlPid = pid()
Reason = term()
This function is used to open a TPKT connection.
The module
option makes it possible for the user to provide
their own callback module. The receive_message/4
or
process_received_message/4
functions 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.
Handle = socket_handle()
This function is used for closing an active TPKT connection.
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.
Handle = socket_handle()
Message = binary() | iolist()
Sends a message on a connection.
Handle = socket_handle()
Stop receiving incoming messages on the socket.
Handle = socket_handle()
Starting to receive incoming messages from the socket again.
ControlPid = pid()
Update the receive handle of the control process (e.g. after having changed protocol version).
TotalStats = [send_handle_stats()]
total_stats() = {send_handle(), [stats()]}
SendHandle = send_handle()
SendHandleStats = [stats()]
Counter = tcp_stats_counter()
CounterStats = integer()
stats() = {tcp_stats_counter(), integer()}
tcp_stats_counter() = medGwyGatewayNumInMessages | medGwyGatewayNumInOctets | medGwyGatewayNumOutMessages | medGwyGatewayNumOutOctets | medGwyGatewayNumErrors
Reason = term()
Retreive the TCP related (SNMP) statistics counters.
SendHandle = send_handle()
Reset all TCP related (SNMP) statistics counters.