File 4131-megaco-Types-and-spec-for-megaco-disconnec... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 4131-megaco-Types-and-spec-for-megaco-disconnect-2.patch of Package erlang

From cb94706472153000a124fad4df04b2e291e80f6f Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 22 Dec 2023 16:41:44 +0100
Subject: [PATCH 11/46] [megaco] Types and spec for megaco:disconnect/2

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 13 ++++++++-----
 lib/megaco/src/app/megaco.erl |  5 +++++
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index bb3a765eea..ca8d06506c 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -1704,18 +1704,22 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason}</name>
+ <name name="disconnect" arity="2" clause_i="1" since=""/>
+ 
 <fsummary>Tear down a "virtual" connection</fsummary>
+ 
 <desc>
 Tear down a "virtual" connection
- Causes the UserMod:handle_disconnect/2 callback function to
- be invoked. See the megaco_user module for more info about
- the callback arguments.
+	Causes the <c><![CDATA[UserMod:handle_disconnect/2]]></c>
+	callback function to be invoked.
+	See the megaco_user module for more info about
+	the callback arguments.
 
 <marker id="call"></marker> 
 </desc>
@@ -2280,7 +2284,6 @@ megaco_incr_timer() = #megaco_incr_timer{}
 
 <func>
 <name name="disable_trace" arity="0" clause_i="1" since=""/>
- 
 <fsummary>Stop megaco tracing</fsummary>
 <desc>
 This function is used to stop megaco tracing.
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index c3d2f892ee..7be0b3ec74 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -410,6 +410,11 @@ connect(ReceiveHandle, RemoteMid, SendHandle, ControlPid, Extra)
 %% Tear down a "virtual" connection
 %%-----------------------------------------------------------------
 
+-spec disconnect(ConnHandle, DiscoReason) -> ok | {error, ErrReason} when
+ ConnHandle :: conn_handle(),
+ DiscoReason :: term(),
+ ErrReason :: term().
+
 disconnect(ConnHandle, Reason) ->
 megaco_messenger:disconnect(ConnHandle, {user_disconnect, Reason}).
 
-- 
2.35.3

Places

File 4131-megaco-Types-and-spec-for-megaco-disconnect-2.patch of Package erlang

Places