Types
TransportRef = pid()
This function is used for starting the TCP/IP transport service. Use exit(TransportRef, Reason) to stop the transport service.
megaco_tcp
Types
TransportRef = pid() | regname()
OptionListPerPort = [Option]
Option = {port, integer()} |
{options, list()} |
{receive_handle, term()} |
{inet_backend, default | inet | socket}
This function is used for starting new TPKT listening socket for TCP/IP. The option list contains the socket definitions.
- inet_backend
-
Choose the inet-backend.
This option make it possible to use a different inet-backend ('default', 'inet' or 'socket').
Default is default (system default).
Types
TransportRef = pid() | regname()
OptionList = [Option]
Option = {host, IpAddr} |
{port, integer()} |
{options, list()} |
{receive_handle, term()} |
{module, atom()} |
{inet_backend, default | inet | socket}
Handle = socket_handle()
ControlPid = pid()
Reason = term()
This function is used to open a TPKT connection.
- module
-
This 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 is called depends on the size of the message;
- small
receive_message
- large
process_received_message
Default value is megaco.
- inet_backend
-
Choose the inet-backend.
This option make it possible to use a different inet-backend ('default', 'inet' or 'socket').
Default is default (system default).
Types
Handle = socket_handle()
This function is used for closing an active TPKT connection.
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.
Types
Handle = socket_handle()
Message = binary() | iolist()
Sends a message on a connection.
Types
Handle = socket_handle()
Stop receiving incoming messages on the socket.
Types
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.
Types
SendHandle = send_handle()
Reset all TCP related (SNMP) statistics counters.