megaco_tcp

MODULE

megaco_tcp

MODULE SUMMARY

Interface module to TPKT transport protocol for Megaco/H.248.

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:
TransportRef = pid()

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

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

Types:
TransportRef = pid() | regname()
OptionList = [Option]
Option = {port, integer()} | {host, Ipaddr} |{options, list()} |{receive_handle, term()}
Handle = socket_handle()
ControlPid = pid()
Reason = term()

This function is used to open a TPKT connection.

close(Handle) -> ok

Types:
Handle = socket_handle()

This function is used for closing an active TPKT connection.

socket(Handle) -> Socket

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.

send_message(Handle, Message) -> ok

Types:
Handle = socket_handle()
Message = binary() | iolist()

Sends a message on a connection.

block(Handle) -> ok

Types:
Handle = socket_handle()

Stop receiving incomming messages on the socket.

unblock(Handle) -> ok

Types:
Handle = socket_handle()

Starting to receive incomming messages from the socket again.

AUTHORS

Lars Thorsén - support@erlang.ericsson.se