Update documentation

1 files changed, 53 insertions, 14 deletions

diff --git a/lib/snmp/doc/src/snmpa_mpd.xml b/lib/snmp/doc/src/snmpa_mpd.xml
index c5ab0a0520..518100d30c 100644
--- a/lib/snmp/doc/src/snmpa_mpd.xml
+++ b/lib/snmp/doc/src/snmpa_mpd.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1999</year><year>2013</year>
+      <year>1999</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -43,6 +43,12 @@
     <marker id="init"></marker>
   </description>
 
+  <section>
+    <title>DATA TYPES</title>
+    <p>See the <seealso marker="snmpa_conf#types">
+    data types in <c>snmpa_conf</c></seealso>.</p>
+  </section>
+
   <funcs>
     <func>
       <name>init(Vsns) -> mpd_state()</name>
@@ -63,16 +69,17 @@
     </func>
 
     <func>
-      <name>process_packet(Packet, TDomain, TAddress, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
-      <name>process_packet(Packet, TDomain, TAddress, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
+      <name>process_packet(Packet, From, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
+      <name>process_packet(Packet, From, LocalEngineID, State, NoteStore, Log) -> {ok, Vsn, Pdu, PduMS, ACMData} | {discarded, Reason} | {discovery, DiscoPacket}</name>
       <fsummary>Process a packet received from the network</fsummary>
       <type>
         <v>Packet = binary()</v>
-        <v>TDomain = snmpUDPDomain</v>
-        <v>TAddress = {Ip, Udp}</v>
+	<v>From = {TDomain, TAddr}</v>
+        <v>TDomain = transportDomainUdpIpv4 | transportDomainUdpIpv6</v>
+        <v>TAddr = {IpAddr, IpPort}</v>
         <v>LocalEngineID = string()</v>
-        <v>Ip = {integer(), integer(), integer(), integer()}</v>
-        <v>Udp = integer()</v>
+        <v>IpAddr = <seealso marker="kernel:inet#type-ip_address">inet:ip_address()</seealso></v>
+        <v>IpPort = inet:port_number()</v>
         <v>State = mpd_state()</v>
         <v>NoteStore = pid()</v>
         <v>Log = snmp_log()</v>
@@ -85,7 +92,7 @@
       </type>
       <desc>
         <p>Processes an incoming packet.  Performs authentication and 
-          decryption as necessary.  The return values should be passed the
+          decryption as necessary.  The return values should be passed to the
           agent.</p>
 
         <note>
@@ -150,14 +157,20 @@
           network.
           </p>
         <p><c>MsgData</c> is the message specific data used in
-          the SNMP message.  This value is received in a <c>send_pdu</c>
-          or <c>send_pdu_req</c> message from the agent.  In SNMPv1 and
+          the SNMP message.  This value is received in a
+	  <seealso marker="snmp_agent_netif#im_send_pdu"><c>send_pdu</c></seealso>
+          or
+	  <seealso marker="snmp_agent_netif#im_send_pdu_req">
+	  <c>send_pdu_req</c></seealso>
+	  message from the agent.  In SNMPv1 and
           SNMPv2c, this message data is the community string.  In
-          SNMPv3, it is the context information.
-          <c>To</c> is a list of the destination addresses and
+          SNMPv3, it is the context information.</p>
+	<p>
+          <c>To</c> is a list of destination addresses and
           their corresponding security parameters.  This value is
-          also received from the requests mentioned above.
-          </p>
+          received in the same message from the agent and then transformed
+	  trough <seealso marker="#process_taddrs"><c>process_taddrs</c></seealso>
+	  before passed to this function.</p>
 
         <note>
           <p>Note that the use of the LocalEngineID argument is only intended 
@@ -166,6 +179,32 @@
             (see SNMP-FRAMEWORK-MIB). </p>
 	</note>
 
+        <marker id="process_taddrs"></marker>
+      </desc>
+    </func>
+
+    <func>
+      <name>process_taddrs(TDests) -> Dests</name>
+      <fsummary>Transform addresses from internal MIB format to a less internal
+      </fsummary>
+      <type>
+	<v>TDests = [TDest]</v>
+	<v>TDest = {{TDomain, TAddr}, SecData} | {TDomain, TAddr}</v>
+	<v>TDomain = term()  % Not at tuple</v>
+	<v>TAddr = term()</v>
+	<v>SecData = term()</v>
+	<v>Dests = [Dest]</v>
+	<v>Dest = {{Domain, Addr}, SecData} | {Domain, Addr}</v>
+	<v>Domain = transportDomain()</v>
+	<v>Addr = transportAddress()  % Depends on Domain</v>
+      </type>
+      <desc>
+	<p>Transforms addresses from internal MIB format to one
+	more useful to <seealso marker="snmp_agent_netif">Agent Net if</seealso>.
+	</p>
+	<p>See also <seealso marker="#generate_msg"><c>generate_msg</c>.</seealso>
+	</p>
+
         <marker id="discarded_pdu"></marker>
       </desc>
     </func>