View Source megaco_tcp (megaco v4.6)

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.

Summary

Functions

block(Handle) -> ok

close(Handle) -> ok

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

Equivalent to get_stats/2

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

listen(TransportRef, ListenPortSpecList) -> ok

reset_stats(SendHandle) -> void()

send_message(Handle, Message) -> ok

socket(Handle) -> Socket

start_transport() -> {ok, TransportRef}

unblock(Handle) -> ok

upgrade_receive_handle(ControlPid, NewHandle) -> ok

Functions

block(Handle) -> ok

Stop receiving incoming messages on the socket.

close(Handle) -> ok

This function is used for closing an active TPKT connection.

Link to this function

connect(SupPid, Parameters)

View Source

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

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).

Equivalent to get_stats/2

Equivalent to get_stats/2

Link to this function

get_stats(Socket, Counter)

View Source

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

Retreive the TCP related (SNMP) statistics counters.

Link to this function

listen(SupPid, Parameters)

View Source

listen(TransportRef, ListenPortSpecList) -> ok

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).

Equivalent to reset_stats/1

reset_stats(SendHandle) -> void()

Reset all TCP related (SNMP) statistics counters.

Link to this function

send_message(Socket, Data)

View Source

send_message(Handle, Message) -> ok

Sends a message on a connection.

socket(Handle) -> 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.

start_transport() -> {ok, TransportRef}

This function is used for starting the TCP/IP transport service. Use exit(TransportRef, Reason) to stop the transport service.

unblock(Handle) -> ok

Starting to receive incoming messages from the socket again.

Link to this function

upgrade_receive_handle(Pid, NewHandle)

View Source

upgrade_receive_handle(ControlPid, NewHandle) -> ok

Update the receive handle of the control process (e.g. after having changed protocol version).