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

snmpm_mpd(3erl) 					     Erlang Module Definition						   snmpm_mpd(3erl)

NAME

       snmpm_mpd - Message Processing and Dispatch module for the SNMP manager

DESCRIPTION

       The  module  snmpm_mpd implements the version independent Message Processing and Dispatch functionality in SNMP for the manager. It is sup-
       posed to be used from a Network Interface process ( Definition of Manager Net if ).

EXPORTS

       init_mpd(Vsns) -> mpd_state()

	      Types  Vsns = [Vsn]
		     Vsn = v1 | v2 | v3

	      This function can be called from the net_if process at start-up. The options list defines which versions to use.

	      It also initializes some SNMP counters.

       process_msg(Msg, TDomain, Addr, Port, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}

	      Types  Msg = binary()
		     TDomain = snmpUDPDomain
		     Addr = {integer(), integer(), integer(), integer()}
		     Port = integer()
		     State = mpd_state()
		     NoteStore = pid()
		     Logger = function()
		     Vsn = 'version-1' | 'version-2' | 'version-3'
		     Pdu = #pdu
		     PduMs = integer()
		     MsgData = term()

	      Processes an incoming message. Performs authentication and decryption as necessary. The return values should be passed  the  manager
	      server.

	      NoteStore is the pid() of the note-store process.

	      Logger is the function used for audit trail logging.

	      In the case when the pdu type is report , MsgData is either ok or {error, ReqId, Reason} .

       generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}

	      Types  Vsn = 'version-1' | 'version-2' | 'version-3'
		     NoteStore = pid()
		     Pdu = #pdu
		     MsgData = term()
		     Logger = function()
		     Packet = binary()
		     Reason = term()

	      Generates a possibly encrypted packet to be sent to the network.

	      NoteStore is the pid() of the note-store process.

	      MsgData  is the message specific data used in the SNMP message. In SNMPv1 and SNMPv2c, this message data is the community string. In
	      SNMPv3, it is the context information.

	      Logger is the function used for audit trail logging.

       generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}

	      Types  Vsn = 'version-1' | 'version-2' | 'version-3'
		     Pdu = #pdu
		     MsgData = term()
		     Logger = function()
		     Packet = binary()
		     Reason = term()

	      Generates a possibly encrypted response packet to be sent to the network.

	      MsgData is the message specific data used in the SNMP message. This value is received from the process_msg function.

Ericsson AB							     snmp 4.19							   snmpm_mpd(3erl)

Linux and UNIX Man Pages

megaco_transport(3erl) [linux man page]

Check Out this Related Man Page