File: snmpa_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 (193 lines) | stat: -rw-r--r-- 5,472 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmpa_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>snmpa_mpd</H1>
</CENTER>

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

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

</DIV>

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

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


</DIV>

<H3>EXPORTS</H3>

<P><A NAME="init/1"><STRONG><CODE>init(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.


</DIV>

<P><A NAME="process_packet/4"><STRONG><CODE>process_packet(Packet, TDomain, TAddress, State) -&#62;
{ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Packet = binary()</CODE></STRONG><BR>
<STRONG><CODE>TDomain = snmpUDPDomain</CODE></STRONG><BR>
<STRONG><CODE>TAddress = {Ip, Udp}</CODE></STRONG><BR>
<STRONG><CODE>Ip = {integer(), integer(), integer(), integer()}</CODE></STRONG><BR>
<STRONG><CODE>Udp = integer()</CODE></STRONG><BR>
<STRONG><CODE>State = mpd_state()</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>ACMData = acm_data()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

</DIV>

<P><A NAME="generate_response_msg/4"><STRONG><CODE>generate_response_msg(Vsn, RePdu, Type, ACMData) -&#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>RePdu = #pdu</CODE></STRONG><BR>
<STRONG><CODE>Type = atom()</CODE></STRONG><BR>
<STRONG><CODE>ACMData = acm_data()</CODE></STRONG><BR>
<STRONG><CODE>Packet = binary()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Generates a possibly encrypted response packet to be sent to the
network. <CODE>Type</CODE> is the <CODE>#pdu.type</CODE> of the original
request.

</DIV>

<P><A NAME="generate_msg/4"><STRONG><CODE>generate_msg(Vsn, Pdu, MsgData, To) -&#62;
{ok, PacketsAndAddresses} | {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 = msg_data()</CODE></STRONG><BR>
<STRONG><CODE>To = [dest_addrs()]</CODE></STRONG><BR>
<STRONG><CODE>PacketsAndAddresses = [{TDomain, TAddress, Packet}]</CODE></STRONG><BR>
<STRONG><CODE>TDomain = snmpUDPDomain</CODE></STRONG><BR>
<STRONG><CODE>TAddress = {Ip, Udp}</CODE></STRONG><BR>
<STRONG><CODE>Ip = {integer(), integer(), integer(), integer()}</CODE></STRONG><BR>
<STRONG><CODE>Udp = integer()</CODE></STRONG><BR>
<STRONG><CODE>Packet = binary()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

        
<P><CODE>MsgData</CODE> is the message specific data used in
         the SNMP message. This value is received in a <CODE>send_pdu</CODE>
or <CODE>send_pdu_req</CODE> message from the agent. In SNMPv1 and
         SNMPv2c, this message data is the community string. In
         SNMPv3, it is the context information.
         
         <CODE>To</CODE> is a list of the destination addresses and
         their corresponding security parameters. This value is
         also received from the requests mentioned above.


</DIV>

<P><A NAME="discarded_pdu/1"><STRONG><CODE>discarded_pdu(Variable) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Variable = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Increments the variable associated with a discarded pdu.
This function can be used when the net_if process receives a
<CODE>discarded_pdu</CODE> message from the agent.


</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Martin Bjrklund - 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>