aboutsummaryrefslogtreecommitdiffstats
path: root/lib/snmp/doc/src/snmpm_network_interface.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_network_interface.xml
parent5bd1edc7b53dbcea6f63e0a7fb57925935e6b293 (diff)
downloadotp-fcc898b0b296376167a2a2094d0a822090cfb20e.tar.gz
otp-fcc898b0b296376167a2a2094d0a822090cfb20e.tar.bz2
otp-fcc898b0b296376167a2a2094d0a822090cfb20e.zip
Update documentation
Diffstat (limited to 'lib/snmp/doc/src/snmpm_network_interface.xml')
-rw-r--r--lib/snmp/doc/src/snmpm_network_interface.xml12
1 files changed, 8 insertions, 4 deletions
diff --git a/lib/snmp/doc/src/snmpm_network_interface.xml b/lib/snmp/doc/src/snmpm_network_interface.xml
index 6cf7bd6ed7..bea6b46dc7 100644
--- a/lib/snmp/doc/src/snmpm_network_interface.xml
+++ b/lib/snmp/doc/src/snmpm_network_interface.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>
@@ -69,6 +69,10 @@
<p>The semantics of them and their exact signatures are explained
below. </p>
+ <p>Legacy API function <c>send_pdu/7</c> that has got separate
+ <c>IpAddr</c> and <c>PortNumber</c> arguments still works as before
+ for backwards compatibility reasons.</p>
+
<marker id="start_link"></marker>
</description>
@@ -103,15 +107,15 @@
</func>
<func>
- <name>send_pdu(Pid, Pdu, Vsn, MsgData, Addr, Port, ExtraInfo) -> void()</name>
+ <name>send_pdu(Pid, Pdu, Vsn, MsgData, Domain, Addr, ExtraInfo) -> void()</name>
<fsummary>Request the network interface process to send this pdu</fsummary>
<type>
<v>Pid = pid()</v>
<v>Pdu = pdu()</v>
<v>Vsn = 'version-1' | 'version-2' | 'version-3'</v>
<v>MsgData = term()</v>
- <v>Addr = address()</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>ExtraInfo = term()</v>
</type>
<desc>