File 0196-kernel-Correct-inet-monitor-1-documentatio... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0196-kernel-Correct-inet-monitor-1-documentation.patch of Package erlang (Revision 49ffc32558c33a37698f7203f8264896)

Currently displaying revision 49ffc32558c33a37698f7203f8264896 , Show latest

From e057660ea67594ecde17c0da90c8eebca459fbf1 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 20 Sep 2021 17:38:55 +0200
Subject: [PATCH] [kernel] Correct inet:monitor/1 documentation

Add text about the 'Type' (port or socket).

OTP-17640
---
 lib/kernel/doc/src/inet.xml | 15 +++++++++++----
 1 file 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:
 	<code type="none">
-	 {'DOWN', MonitorRef, socket, Object, Info}
+	 {'DOWN', MonitorRef, Type, Object, Info}
 	 </code>
- In the monitor message <c>MonitorRef</c> and <c>Type</c> are the
- same as described earlier, and:
 <taglist>
+ <tag><c>MonitorRef</c></tag>
+ <item>
+	 The identity of the socket. 
+ </item>
+ <tag><c>Type</c></tag>
+ <item>
+	 The type of socket, can be one of the following atoms:
+	 port or socket. 
+ </item>
 <tag><c>Object</c></tag>
 <item>
-	 The monitored entity, socket, which triggered the event. 
+	 The monitored entity, the socket, which triggered the event. 
 </item>
 <tag><c>Info</c></tag>
 <item>
-- 
2.31.1

Places

File 0196-kernel-Correct-inet-monitor-1-documentation.patch of Package erlang (Revision 49ffc32558c33a37698f7203f8264896)

Places