File: snmpm_mpd.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (189 lines) | stat: -rw-r--r-- 5,369 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmpm_mpd</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>snmpm_mpd</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmpm_mpd
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
 Message Processing and Dispatch module for the SNMP manager

</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>The module <CODE>snmpm_mpd</CODE> implements the version independent
Message Processing and Dispatch functionality in SNMP for the manager. 
It is supposed to be used from a Network Interface process 
(<A HREF="snmp_manager_netif.html">Definition of Manager Net if</A>).


</DIV>

<H3>EXPORTS</H3>

<P><A NAME="init_mpd/1"><STRONG><CODE>init_mpd(Vsns) -&#62; mpd_state()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Vsns = [Vsn]</CODE></STRONG><BR>
<STRONG><CODE>Vsn = v1 | v2 | v3</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>This function can be called from the net_if process at startup.
         The options list defines which versions to use.
         
        
<P>It also initializes some SNMP counters.
         
         <A NAME="process_msg"><!-- Empty --></A> 

</DIV>

<P><A NAME="process_msg/7"><STRONG><CODE>process_msg(Msg, TDomain, Addr, Port, State, NoteStore, Logger) -&#62;
{ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Msg = binary()</CODE></STRONG><BR>
<STRONG><CODE>TDomain = snmpUDPDomain</CODE></STRONG><BR>
<STRONG><CODE>Addr = {integer(), integer(), integer(), integer()}</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>State = mpd_state()</CODE></STRONG><BR>
<STRONG><CODE>NoteStore = pid()</CODE></STRONG><BR>
<STRONG><CODE>Logger = function()</CODE></STRONG><BR>
<STRONG><CODE>Vsn = 'version-1' | 'version-2' | 'version-3'</CODE></STRONG><BR>
<STRONG><CODE>Pdu = #pdu</CODE></STRONG><BR>
<STRONG><CODE>PduMs = integer()</CODE></STRONG><BR>
<STRONG><CODE>MsgData = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

        
<P><CODE>NoteStore</CODE> is the <CODE>pid()</CODE> of the note-store process.
        
<P><CODE>Logger</CODE> is the function used for audit trail logging.

        
<P>In the case when the pdu type is <CODE>report</CODE>, <CODE>MsgData</CODE> is 
         either <CODE>ok</CODE> or <CODE>{error, ReqId, Reason}</CODE>.


</DIV>

<P><A NAME="generate_msg/5"><STRONG><CODE>generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -&#62;
{ok, Packet} | {discarded, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Vsn = 'version-1' | 'version-2' | 'version-3'</CODE></STRONG><BR>
<STRONG><CODE>NoteStore = pid()</CODE></STRONG><BR>
<STRONG><CODE>Pdu = #pdu</CODE></STRONG><BR>
<STRONG><CODE>MsgData = term()</CODE></STRONG><BR>
<STRONG><CODE>Logger = function()</CODE></STRONG><BR>
<STRONG><CODE>Packet = binary()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Generates a possibly encrypted packet to be sent to the network.

        
<P><CODE>NoteStore</CODE> is the <CODE>pid()</CODE> of the note-store process.

        
<P><CODE>MsgData</CODE> 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.
         
        
<P><CODE>Logger</CODE> is the function used for audit trail logging.


</DIV>

<P><A NAME="generate_response_msg/4"><STRONG><CODE>generate_response_msg(Vsn, Pdu, MsgData, Logger) -&#62;
{ok, Packet} | {discarded, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Vsn = 'version-1' | 'version-2' | 'version-3'</CODE></STRONG><BR>
<STRONG><CODE>Pdu = #pdu</CODE></STRONG><BR>
<STRONG><CODE>MsgData = term()</CODE></STRONG><BR>
<STRONG><CODE>Logger = function()</CODE></STRONG><BR>
<STRONG><CODE>Packet = binary()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

        
<P><CODE>MsgData</CODE> is the message specific data used in the SNMP 
         message. Thes value is received from the 
         <A HREF="snmpm_mpd.html#process_msg">process_msg</A> 
         function.
         

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Micael Karlberg - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>