File 2033-megaco-Types-and-spec-for-megaco-receive_m... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2033-megaco-Types-and-spec-for-megaco-receive_message-4-5.patch of Package erlang

From 4a74bb44645a80ae4469ba5c9fe86fd326346685 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 2 Jan 2024 18:41:08 +0100
Subject: [PATCH 23/46] [megaco] Types and spec for megaco:receive_message/4,5

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 28 +++++++++++-----------------
 lib/megaco/src/app/megaco.erl | 16 ++++++++++++++++
 2 files changed, 27 insertions(+), 17 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index b7c11df74d..254aade59e 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -2135,28 +2135,22 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) -> ok</name>
- <name since="">receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) -> ok</name>
+ <name name="receive_message" arity="4" clause_i="1" since=""/>
+ <name name="receive_message" arity="5" clause_i="1" since=""/>
 <fsummary>Process a received message</fsummary>
- <type>
- <v>ReceiveHandle = #megaco_receive_handle{}</v>
- <v>ControlPid = pid()</v>
- <v>SendHandle = term()</v>
- <v>BinMsg = binary()</v>
- <v>Extra = term()</v>
- </type>
 <desc>
 Process a received message
 This is a callback function intended to be invoked by some
- transport modules when get an incoming message. Which
- transport that actually is used is up to the user to
- choose.
- In principle, this function calls the 
- <c><![CDATA[process_received_message/4]]></c> function via a <c><![CDATA[spawn]]></c> to
- perform the actual processing.
+	transport modules when get an incoming message. Which
+	transport that actually is used is up to the user to
+	choose.
+	In principle, this function calls the 
+	<c><![CDATA[process_received_message/4,5]]></c>
+	function via a <c><![CDATA[spawn]]></c> to
+	perform the actual processing.
 For further information see the 
- <seeerl marker="#process_received_message">process_received_message/4</seeerl> 
- function.
+	<seeerl marker="#process_received_message">process_received_message/4,5</seeerl> 
+	function.
 
 <marker id="parse_digit_map"></marker>
 </desc>
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index 4c05bbeee9..e184179bd2 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -627,10 +627,26 @@ process_received_message(ReceiveHandle,
 					 SendHandle, BinMsg, 
 					 Extra).
 
+
+-spec receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) ->
+ ok when
+ ReceiveHandle :: receive_handle(),
+ ControlPid :: pid(),
+ SendHandle :: send_handle(),
+ BinMsg :: binary().
+
 receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg) ->
 megaco_messenger:receive_message(ReceiveHandle, ControlPid, 
 				 SendHandle, BinMsg).
 
+-spec receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) ->
+ ok when
+ ReceiveHandle :: receive_handle(),
+ ControlPid :: pid(),
+ SendHandle :: send_handle(),
+ BinMsg :: binary(),
+ Extra :: term().
+
 receive_message(ReceiveHandle, ControlPid, SendHandle, BinMsg, Extra) ->
 megaco_messenger:receive_message(ReceiveHandle, ControlPid, 
 				 SendHandle, BinMsg,
-- 
2.35.3

Places

File 2033-megaco-Types-and-spec-for-megaco-receive_message-4-5.patch of Package erlang

Places