megaco_tcp
MODULE
MODULE SUMMARY
DESCRIPTION
This module contains the public interface to the TPKT (TCP/IP) version transport protocol for Megaco/H.248.
EXPORTS
start_transport() -> {ok, TransportRef}
Types:
This function is used for starting the TCP/IP transport service. Use exit(TransportRef, Reason) to stop the transport service.
listen(TransportRef, ListenPortSpecList) -> ok
Types:
This function is used for starting new TPKT listening socket for TCP/IP. The option list contains the socket definitions.
connect(TransportRef, OptionList) -> {ok, Handle, ControlPid} | {error, Reason}
Types:
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.
Types:
This function is used for closing an active TPKT connection.
Types:
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.
send_message(Handle, Message) -> ok
Types:
Sends a message on a connection.
Types:
Stop receiving incoming messages on the socket.
Types:
upgrade_receive_handle(ControlPid) -> ok
Types:
get_stats() -> {ok, TotalStats} | {error, Reason}
get_stats(SendHandle) -> {ok, SendHandleStats} | {error, Reason}
get_stats(SendHandle, Counter) -> {ok, CounterStats} | {error, Reason}
Types:
Retreive the TCP related (SNMP) statistics counters.
reset_stats() -> void()
reset_stats(SendHandle) -> void()
Types:
Reset all TCP related (SNMP) statistics counters.