aboutsummaryrefslogtreecommitdiffstats
path: root/lib/snmp/doc/src/snmpm_mpd.xml
diff options
context:
space:
mode:
authorRaimo Niskanen <[email protected]>2014-08-29 16:41:44 +0200
committerRaimo Niskanen <[email protected]>2014-09-03 16:03:19 +0200
commitfcc898b0b296376167a2a2094d0a822090cfb20e (patch)
treefe53d26e2302b207cec3b3fc73d44d5d2a021a7d /lib/snmp/doc/src/snmpm_mpd.xml
parent5bd1edc7b53dbcea6f63e0a7fb57925935e6b293 (diff)
downloadotp-fcc898b0b296376167a2a2094d0a822090cfb20e.tar.gz
otp-fcc898b0b296376167a2a2094d0a822090cfb20e.tar.bz2
otp-fcc898b0b296376167a2a2094d0a822090cfb20e.zip
Update documentation
Diffstat (limited to 'lib/snmp/doc/src/snmpm_mpd.xml')
-rw-r--r--lib/snmp/doc/src/snmpm_mpd.xml14
1 files changed, 9 insertions, 5 deletions
diff --git a/lib/snmp/doc/src/snmpm_mpd.xml b/lib/snmp/doc/src/snmpm_mpd.xml
index ad72fd7bc0..c23b2b6833 100644
--- a/lib/snmp/doc/src/snmpm_mpd.xml
+++ b/lib/snmp/doc/src/snmpm_mpd.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>2004</year><year>2013</year>
+ <year>2004</year><year>2014</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -39,7 +39,12 @@
It is supposed to be used from a Network Interface process
(<seealso marker="snmp_manager_netif">Definition of Manager Net if</seealso>).
</p>
+
+ <p>Legacy API function <c>process_msg/7</c> that has got separate
+ <c>IpAddr</c> and <c>PortNumber</c> arguments still works as before
+ for backwards compatibility reasons.</p>
</description>
+
<funcs>
<func>
<name>init_mpd(Vsns) -> mpd_state()</name>
@@ -58,13 +63,12 @@
</desc>
</func>
<func>
- <name>process_msg(Msg, TDomain, Addr, Port, State, NoteStore, Logger) -> {ok, Vsn, Pdu, PduMS, MsgData} | {discarded, Reason}</name>
+ <name>process_msg(Msg, Domain, Addr, 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>Domain = transportDomainUdpIpv4 | transportDomainUdpIpv6</v>
+ <v>Addr = {<seealso marker="kernel:inet#type-ip_address">inet:ip_address(), inet:port_number()</seealso>} </v>
<v>State = mpd_state()</v>
<v>NoteStore = pid()</v>
<v>Logger = function()</v>