megaco_tcp(3erl) [linux man page]

megaco_tcp(3erl)					     Erlang Module Definition						  megaco_tcp(3erl)

NAME

       megaco_tcp - 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 = {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 .

       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 incoming messages on the socket.

       unblock(Handle) -> ok

	      Types  Handle = socket_handle()

	      Starting to receive incoming messages from the socket again.

       upgrade_receive_handle(ControlPid) -> ok

	      Types  ControlPid = pid()

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

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

	      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 |  medGwyGatewayNu-
		     mOutOctets | medGwyGatewayNumErrors
		     Reason = term()

	      Retreive the TCP related (SNMP) statistics counters.

       reset_stats() -> void()
       reset_stats(SendHandle) -> void()

	      Types  SendHandle = send_handle()

	      Reset all TCP related (SNMP) statistics counters.

Ericsson AB							   megaco 3.15.1						  megaco_tcp(3erl)

Check Out this Related Man Page

inets(3erl)						     Erlang Module Definition						       inets(3erl)

NAME

       inets - The inets services API

DESCRIPTION

       This module provides the most basic API to the clients and servers, that are part of the Inets application, such as start and stop.

COMMON DATA TYPES

       Type definitions that are used more than once in this module:

       service() = ftpc | tftp | httpc | httpd

       property() = atom()

EXPORTS

       services() -> [{Service, Pid}]

	      Types  Service = service()
		     Pid = pid()

	      Returns a list of currently running services.

   Note:
       Services started as stand_alone will not be listed.

       services_info() -> [{Service, Pid, Info}]

	      Types  Service = service()
		     Pid = pid()
		     Info = [{Option, Value}]
		     Option = property()
		     Value = term()

	      Returns  a  list of currently running services where each service is described by a [{Option, Value}] list. The information given in
	      the list is specific for each service and it is probable that each service will have its own info function that gives you even  more
	      details about the service.

       service_names() -> [Service]

	      Types  Service = service()

	      Returns a list of available service names.

       start() ->
       start(Type) -> ok | {error, Reason}

	      Types  Type = permanent | transient | temporary

	      Starts the Inets application. Default type is temporary. See also application(3erl)

       stop() -> ok

	      Stops the inets application. See also application(3erl)

       start(Service, ServiceConfig) -> {ok, Pid} | {error, Reason}
       start(Service, ServiceConfig, How) -> {ok, Pid} | {error, Reason}

	      Types  Service = service()
		     ServiceConfig = [{Option, Value}]
		     Option = property()
		     Value = term()
		     How = inets | stand_alone - default is inets

	      Dynamically starts an inets service after the inets application has been started.

   Note:
       Dynamically  started services will not be handled by application takeover and failover behavior when inets is run as a distributed applica-
       tion. Nor will they be automatically restarted when the inets application is restarted, but as long as the inets application is up and run-
       ning  they  will  be supervised and may be soft code upgraded. Services started as stand_alone , e.i. the service is not started as part of
       the inets application, will lose all OTP application benefits such as soft upgrade. The "stand_alone-service" will be linked to the process
       that  started  it. In most cases some of the supervision functionality will still be in place and in some sense the calling process has now
       become the top supervisor.

       stop(Service, Reference) -> ok | {error, Reason}

	      Types  Service = service() | stand_alone
		     Reference = pid() | term() - service specified reference
		     Reason = term()

	      Stops a started service of the inets application or takes down a "stand_alone-service" gracefully. When the  stand_alone	option	is
	      used in start, only the pid is a valid argument to stop.

SEE ALSO

       ftp(3erl) , httpc(3erl) , httpd(3erl) , tftp(3erl)

Ericsson AB							    inets 5.5.2 						       inets(3erl)

Linux and UNIX Man Pages

megaco_tcp(3erl) [linux man page]

Check Out this Related Man Page