summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErlang/OTP <otp@erlang.org>2021-09-30 11:49:21 +0200
committerErlang/OTP <otp@erlang.org>2021-09-30 11:49:21 +0200
commite9bb0105ef98dc52c7e48460cc7c4774cc1bafdd (patch)
treee5dc55e0691c8cd25916a9b47c097d977284b3c8
parent1b0a9a039a1d078c8e4f25f3eaa765259b256ace (diff)
parente057660ea67594ecde17c0da90c8eebca459fbf1 (diff)
downloaderlang-e9bb0105ef98dc52c7e48460cc7c4774cc1bafdd.tar.gz
Merge branch 'bmk/kernel/20210924/inet_monitor_doc/OTP-17640' into maint-24
* bmk/kernel/20210924/inet_monitor_doc/OTP-17640: [kernel] Correct inet:monitor/1 documentation
-rw-r--r--lib/kernel/doc/src/inet.xml15
1 files changed, 11 insertions, 4 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index ed21bac53a..8e7fe2f7bf 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -751,14 +751,21 @@ get_tcpi_sacked(Sock) ->
monitor is triggered, a <c>'DOWN'</c> message is sent
that has the following pattern:</p>
<code type="none">
- {'DOWN', MonitorRef, socket, Object, Info}
+ {'DOWN', MonitorRef, Type, Object, Info}
</code>
- <p>In the monitor message <c>MonitorRef</c> and <c>Type</c> are the
- same as described earlier, and:</p>
<taglist>
+ <tag><c>MonitorRef</c></tag>
+ <item>
+ <p>The identity of the socket. </p>
+ </item>
+ <tag><c>Type</c></tag>
+ <item>
+ <p>The type of socket, can be one of the following atoms:
+ port or socket. </p>
+ </item>
<tag><c>Object</c></tag>
<item>
- <p>The monitored entity, socket, which triggered the event. </p>
+ <p>The monitored entity, the socket, which triggered the event. </p>
</item>
<tag><c>Info</c></tag>
<item>