diff options
Diffstat (limited to 'lib/snmp/doc/src/snmpm_mpd.xml')
| -rw-r--r-- | lib/snmp/doc/src/snmpm_mpd.xml | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml new file mode 100644 index 0000000000..030c79e0e6 --- /dev/null +++ b/lib/snmp/doc/src/snmpm_mpd.xml @@ -0,0 +1,139 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2004</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>snmpm_mpd</title> + <prepared></prepared> + <responsible></responsible> + <docno></docno> + <approved></approved> + <checked></checked> + <date></date> + <rev></rev> + <file>snmpm_mpd.xml</file> + </header> + <module>snmpm_mpd</module> + <modulesummary>Message Processing and Dispatch module for the SNMP manager</modulesummary> + <description> + <p>The module <c>snmpm_mpd</c> 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 + (<seealso marker="snmp_manager_netif">Definition of Manager Net if</seealso>). + </p> + </description> + <funcs> + <func> + <name>init_mpd(Vsns) -> mpd_state()</name> + <fsummary>Initialize the MPD module</fsummary> + <type> + <v>Vsns = [Vsn]</v> + <v>Vsn = v1 | v2 | v3</v> + </type> + <desc> + <p>This function can be called from the net_if process at start-up. + The options list defines which versions to use. + </p> + <p>It also initializes some SNMP counters. + <marker id="process_msg"></marker> +</p> + </desc> + </func> + <func> + <name>process_msg(Msg, TDomain, Addr, Port, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}</name> + <fsummary>Process a message received from the network</fsummary> + <type> + <v>Msg = binary()</v> + <v>TDomain = snmpUDPDomain</v> + <v>Addr = {integer(), integer(), integer(), integer()}</v> + <v>Port = integer()</v> + <v>State = mpd_state()</v> + <v>NoteStore = pid()</v> + <v>Logger = function()</v> + <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v> + <v>Pdu = #pdu</v> + <v>PduMs = integer()</v> + <v>MsgData = term()</v> + </type> + <desc> + <p>Processes an incoming message. Performs authentication and + decryption as necessary. The return values should be passed the + manager server. + </p> + <p><c>NoteStore</c> is the <c>pid()</c> of the note-store process.</p> + <p><c>Logger</c> is the function used for audit trail logging. + </p> + <p>In the case when the pdu type is <c>report</c>, <c>MsgData</c> is + either <c>ok</c> or <c>{error, ReqId, Reason}</c>. + </p> + </desc> + </func> + <func> + <name>generate_msg(Vsn, NoteStore, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}</name> + <fsummary>Generate a request message to be sent to the network</fsummary> + <type> + <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v> + <v>NoteStore = pid()</v> + <v>Pdu = #pdu</v> + <v>MsgData = term()</v> + <v>Logger = function()</v> + <v>Packet = binary()</v> + <v>Reason = term()</v> + </type> + <desc> + <p>Generates a possibly encrypted packet to be sent to the network. + </p> + <p><c>NoteStore</c> is the <c>pid()</c> of the note-store process. + </p> + <p><c>MsgData</c> 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> + <p><c>Logger</c> is the function used for audit trail logging. + </p> + </desc> + </func> + <func> + <name>generate_response_msg(Vsn, Pdu, MsgData, Logger) -> {ok, Packet} | {discarded, Reason}</name> + <fsummary>Generate a response packet to be sent to the network</fsummary> + <type> + <v>Vsn = 'version-1' | 'version-2' | 'version-3'</v> + <v>Pdu = #pdu</v> + <v>MsgData = term()</v> + <v>Logger = function()</v> + <v>Packet = binary()</v> + <v>Reason = term()</v> + </type> + <desc> + <p>Generates a possibly encrypted response packet to be sent to the + network. + </p> + <p><c>MsgData</c> is the message specific data used in the SNMP + message. This value is received from the + <seealso marker="snmpm_mpd#process_msg">process_msg</seealso> + function. + </p> + </desc> + </func> + </funcs> + +</erlref> + |