Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

pg(3erl)						     Erlang Module Definition							  pg(3erl)

NAME
pg - Distributed, Named Process Groups DESCRIPTION
This (experimental) module implements process groups. A process group is a group of processes that can be accessed by a common name. For example, a group named foobar can include a set of processes as members of this group and they can be located on different nodes. When messages are sent to the named group, all members of the group receive the message. The messages are serialized. If the process P1 sends the message M1 to the group, and process P2 simultaneously sends message M2 , then all members of the group receive the two messages in the same order. If members of a group terminate, they are automatically removed from the group. This module is not complete. The module is inspired by the ISIS system and the causal order protocol of the ISIS system should also be implemented. At the moment, all messages are serialized by sending them through a group master process. EXPORTS
create(PgName) -> ok | {error, Reason} Types PgName = term() Reason = already_created | term() Creates an empty group named PgName on the current node. create(PgName, Node) -> ok | {error, Reason} Types PgName = term() Node = node() Reason = already_created | term() Creates an empty group named PgName on the node Node . join(PgName, Pid) -> Members Types PgName = term() Pid = pid() Members = [pid()] Joins the pid Pid to the process group PgName . Returns a list of all old members of the group. send(PgName, Msg) -> void() Types PgName = Msg = term() Sends the tuple {pg_message, From, PgName, Msg} to all members of the process group PgName . Failure: {badarg, {PgName, Msg}} if PgName is not a process group (a globally registered name). esend(PgName, Msg) -> void() Types PgName = Msg = term() Sends the tuple {pg_message, From, PgName, Msg} to all members of the process group PgName , except ourselves. Failure: {badarg, {PgName, Msg}} if PgName is not a process group (a globally registered name). members(PgName) -> Members Types PgName = term() Members = [pid()] Returns a list of all members of the process group PgName . Ericsson AB stdlib 1.17.3 pg(3erl)
Man Page