File 1503-megaco-udp-transport-doc-Add-description-o... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1503-megaco-udp-transport-doc-Add-description-of-the-new-.patch of Package erlang (Revision c37f636f556d133a129c9e9a7093d763)

Currently displaying revision c37f636f556d133a129c9e9a7093d763 , Show latest

From 869535711400ebb6239ef83b2c6c0f9da97a7c17 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 23 Jul 2021 10:20:29 +0200
Subject: [PATCH 03/13] [megaco|udp-transport|doc] Add description of the new
 backend option

Add description of the new 'inet_backend' (udp transport) option.

OTP-17533
---
 lib/megaco/doc/src/megaco_udp.xml | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

diff --git a/lib/megaco/doc/src/megaco_udp.xml b/lib/megaco/doc/src/megaco_udp.xml
index 2809bc8ce9..3add131fa8 100644
--- a/lib/megaco/doc/src/megaco_udp.xml
+++ b/lib/megaco/doc/src/megaco_udp.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>2000</year><year>2020</year>
+ <year>2000</year><year>2021</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -56,20 +56,27 @@
 <type>
 <v>TransportRef = pid() | regname()</v>
 <v>OptionList = [option()]</v>
- <v>option() = {port, integer()} |{options, list()} |{receive_handle, receive_handle()} |{module, atom()}</v>
+ <v>option() = {port, integer()} | {options, list()} | {receive_handle, receive_handle()} | {module, atom()} | {inet_backend, default | inet | socket}</v>
 <v>Handle = socket_handle()</v>
 <v>receive_handle() = term()</v>
 <v>ControlPid = pid()</v>
 <v>Reason = term()</v>
 </type>
 <desc>
- This function is used to open an UDP/IP socket.
- The <c><![CDATA[module]]></c> option makes it possible for the user to provide
- their own callback module. The functions <c><![CDATA[receive_message/4]]></c> or
- <c><![CDATA[process_received_message/4]]></c> of this module is called when a new 
- message is received (which one depends on the size of the message; 
- small - receive_message, large - process_received_message). 
- Default value is megaco.
+	This function is used to open an UDP/IP socket.
+	The <c><![CDATA[module]]></c> option makes it possible for the user
+	to provide their own callback module.
+	The functions <c><![CDATA[receive_message/4]]></c> or
+	<c><![CDATA[process_received_message/4]]></c> of this module is called
+	when a new message is received (which one depends on the size of the
+	message: 
+	<taglist>
+	 <tag><c><![CDATA[small]]></c></tag>
+	 <item>receive_message</item>
+	 <tag><c><![CDATA[large]]></c></tag>
+	 <item>process_received_message)</item>
+	</taglist>
+	Default value is (the module) megaco.
 </desc>
 </func>
 <func>
-- 
2.31.1

Places

File 1503-megaco-udp-transport-doc-Add-description-of-the-new-.patch of Package erlang (Revision c37f636f556d133a129c9e9a7093d763)

Places