megaco_transport(3erl) [linux man page]

megaco_transport(3erl)					     Erlang Module Definition					    megaco_transport(3erl)

NAME

       megaco_transport - Megaco transport behaviour.

DESCRIPTION

       The following functions should be exported from a megaco_transport callback module:

	 * send_message/2 [ mandatory ]

	 * send_message/3 [ optional ]

	 * resend_message/2 [ optional ]

	 *

EXPORTS

       Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error
       Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error

	      Types  Handle = term()
		     Msg = binary() | iolist()
		     Resend = boolean()
		     Reason = term()
		     Error = term()

	      Send a megaco message.

	      If the function returns {cancel, Reason} , this means the transport module decided not to send the message. This is not an error. No
	      error messages will be issued and no error counters incremented. What actions this will result in depends on what  kind  of  message
	      was sent.

	      In  the  case of requests, megaco will cancel the message in much the same way as if megaco:cancel had been called (after a success-
	      full send). The information will be propagated back to the user differently depending  on  how  the  request(s)  where  issued:  For
	      requests	issued	using megaco:call , the info will be delivered in the return value. For requests issued using megaco:cast the info
	      will be delivered via a call to the callback function handle_trans_reply .

	      In the case of reply, megaco will cancel the reply and information of this will be returned to the user via a call to  the  callback
	      function handle_trans_ack .

	      The  function  send_message/3  will only be called if the resend_indication config option has been set to the value flag . The third
	      argument, Resend then indicates if the message send is a resend or not.

       Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error

	      Types  Handle = term()
		     Msg = binary() | iolist()
		     Reason = term()
		     Error = term()

	      Re-send a megaco message.

	      Note that this function will only be called if the user has set the resend_indication config option to true and it is in fact a mes-
	      sage resend. If not both of these condition's are meet, send_message will be called.

	      If the function returns {cancel, Reason} , this means the transport module decided not to send the message. This is not an error. No
	      error messages will be issued and no error counters incremented. What actions this will result in depends on what  kind  of  message
	      was sent.

	      In  the  case of requests, megaco will cancel the message in much the same way as if megaco:cancel had been called (after a success-
	      full send). The information will be propagated back to the user differently depending  on  how  the  request(s)  where  issued:  For
	      requests	issued	using megaco:call , the info will be delivered in the return value. For requests issued using megaco:cast the info
	      will be delivered via a call to the callback function handle_trans_reply .

	      In the case of reply, megaco will cancel the reply and information of this will be returned to the user via a call to  the  callback
	      function handle_trans_ack .

Ericsson AB							   megaco 3.15.1					    megaco_transport(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)

Linux and UNIX Man Pages

megaco_transport(3erl) [linux man page]

Check Out this Related Man Page