File 2041-megaco-Types-and-spec-for-megaco-system_in... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2041-megaco-Types-and-spec-for-megaco-system_info-0-1.patch of Package erlang

From 9f3cfbb0a914b2584a8d3604d6f1136db99a4a1e Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 5 Jan 2024 11:12:41 +0100
Subject: [PATCH 31/46] [megaco] Types and spec for megaco:system_info/0,1

OTP-18920
---
 lib/megaco/doc/src/megaco.xml | 141 ++++++++++++++++++++++++----------
 lib/megaco/src/app/megaco.erl |  21 +++++
 2 files changed, 121 insertions(+), 41 deletions(-)

diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml
index ac9112ce13..e0377d8c6c 100644
--- a/lib/megaco/doc/src/megaco.xml
+++ b/lib/megaco/doc/src/megaco.xml
@@ -1064,6 +1064,102 @@
 </desc>
 </datatype>
 
+
+ <datatype>
+ <name name="system_info_item"/>
+ 
+ <desc>
+ <taglist>
+ <tag><c><![CDATA[text_config]]></c></tag>
+ <item>
+ The text encoding config.
+	 Value type:
+	 <seetype marker="erlang#term">term()</seetype>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[connections]]></c></tag>
+ <item>
+ Lists all active connections. Returns a
+	 list of megaco_conn_handle records.
+
+	 Value type:
+	 [<seetype marker="#conn_handle">conn_handle()</seetype>]
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[users]]></c></tag>
+ <item>
+ Lists all active users.
+
+	 Value type:
+	 [<seetype marker="#mid">mid()</seetype>]
+	 
+ </item>
+
+	 
+ <tag><c><![CDATA[n_active_requests]]></c></tag>
+ <item>
+	 Returns number of requests that has originated from
+	 this Erlang node and still are active
+	 (and therefore consumes system resources).
+
+	 Value type:
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[n_active_replies]]></c></tag>
+ <item>
+	 Returns the number of replies that has originated
+	 from this Erlang node and still are active (and
+	 therefore consumes system resources).
+
+	 Value type:
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[n_active_connections]]></c></tag>
+ <item>
+ Returns the number of active connections.
+
+	 Value type:
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[reply_counters]]></c></tag>
+ <item>
+ Returns a list of the reply counters.
+
+	 Value type:
+	 [{<seetype marker="#conn_handle">conn_handle()</seetype>,
+	 <seetype marker="#transaction_id">transaction_id()</seetype>,
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>}]
+	 
+ </item>
+
+
+	 <tag><c><![CDATA[pending_counters]]></c></tag>
+ <item>
+ Returns a list of the receive and sent pending counters.
+
+	 Value type:
+	 [{recv | sent,
+	 [{<seetype marker="#transaction_id">transaction_id()</seetype>,
+	 <seetype marker="erlang#non_neg_integer">non_neg_integer()</seetype>}]}]
+ </item>
+
+	</taglist>
+ </desc>
+ </datatype>
+
 </datatypes>
 
 <section>
@@ -2306,50 +2402,13 @@ megaco_incr_timer() = #megaco_incr_timer{}
 </func>
 
 <func>
- <name since="">system_info() -> [{Item, Value}] | exit(Reason)</name>
- <name since="">system_info(Item) -> Value | exit(Reason)</name>
+ <name name="system_info" arity="0" clause_i="1" since=""/>
+ <name name="system_info" arity="1" clause_i="1" since=""/>
 <fsummary>Lookup system information</fsummary>
- <type>
- <v>Item = system_info_item()</v>
- </type>
 <desc>
- Lookup system information
- The following items are valid:
- <taglist>
- <tag><c><![CDATA[text_config]]></c></tag>
- <item>
- The text encoding config.
- </item>
- <tag><c><![CDATA[connections]]></c></tag>
- <item>
- Lists all active connections. Returns a list of
- megaco_conn_handle records.
- </item>
- <tag><c><![CDATA[users]]></c></tag>
- <item>
- Lists all active users. Returns a list of
- megaco_mid()'s.
- </item>
- <tag><c><![CDATA[n_active_requests]]></c></tag>
- <item>
- Returns an integer representing the number of requests
- that has originated from this Erlang node and still are
- active (and therefore consumes system resources).
- </item>
- <tag><c><![CDATA[n_active_replies]]></c></tag>
- <item>
- Returns an integer representing the number of replies
- that has originated from this Erlang node and still are
- active (and therefore consumes system resources).
- </item>
- <tag><c><![CDATA[n_active_connections]]></c></tag>
- <item>
- Returns an integer representing the number of active
- connections.
- </item>
- </taglist>
+ Lookup system information. 
 
- <marker id="info"></marker>
+	<marker id="info"></marker>
 </desc>
 </func>
 
diff --git a/lib/megaco/src/app/megaco.erl b/lib/megaco/src/app/megaco.erl
index cd5ad69377..9f7bf4a1d1 100644
--- a/lib/megaco/src/app/megaco.erl
+++ b/lib/megaco/src/app/megaco.erl
@@ -240,6 +240,15 @@
 medGwyGatewayNumErrors.
 -type counter_value() :: non_neg_integer().
 
+-type system_info_item() :: text_config |
+ connections |
+ users |
+ n_active_requests |
+ n_active_replies |
+ n_active_connections |
+ reply_counters |
+ pending_counters.
+
 
 -include("megaco_internal.hrl").
 
@@ -428,6 +437,9 @@ extend_users_info([User | Users], Acc) ->
 %% Lookup system information
 %%-----------------------------------------------------------------
 
+-spec system_info_items() -> [Item] when
+ Item :: system_info_item().
+
 system_info_items() ->
 [
 text_config, 
@@ -436,12 +448,21 @@ system_info_items() ->
 n_active_requests, 
 n_active_replies, 
 n_active_connections,
+ reply_counters,
 pending_counters
 ].
 
+-spec system_info() -> [{Item, Value}] when
+ Item :: system_info_item(),
+ Value :: term().
+ 
 system_info() ->
 [{Item, system_info(Item)} || Item <- system_info_items()].
 
+-spec system_info(Item) -> Value when
+ Item :: system_info_item(),
+ Value :: term().
+ 
 system_info(Item) ->
 megaco_config:system_info(Item).
 
-- 
2.35.3

Places

File 2041-megaco-Types-and-spec-for-megaco-system_info-0-1.patch of Package erlang

Places