File 7634-diameter-doc-Add-documentation-for-the-whi... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 7634-diameter-doc-Add-documentation-for-the-which-functio.patch of Package erlang (Revision 22913b88332bf024e9a94e5904b07e48)

Currently displaying revision 22913b88332bf024e9a94e5904b07e48 , Show latest

From 92cc56de684c04bab2760313bb68bfdac2ef30b2 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Wed, 20 Mar 2024 16:06:51 +0100
Subject: [PATCH 4/5] [diameter|doc] Add documentation for the which-functions

---
 lib/diameter/doc/src/diameter.xml | 114 ++++++++++++++++++++++++++++++
 1 file changed, 114 insertions(+)

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 3513fa7c63..bfbc405712 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -1827,6 +1827,120 @@ configured on the transport.
 
 
 
+<func>
+<name since="OTP 25.X">which_connections() -> [SvcConnections]</name>
+<fsummary>Returns a list of connections.</fsummary>
+<type>
+ <v>SvcConnections = {SvcName, [Connection]}</v>
+ <v>SvcName = string()</v>
+ <v>Connection = #{peer := term(),
+ wd := term(),
+ peername := Address,
+ sockname := Address}</v>
+ <v>Address = {inet:ip_address(), inet:port_number()}</v>
+</type>
+<desc>
+
+ Return a list of all connections, grouped by the service they
+ are associated with. 
+
+</desc>
+</func>
+
+<func>
+<name since="OTP 25.X">which_connections(SvcName) -> [Connection]</name>
+<fsummary>Returns a list of connections.</fsummary>
+<type>
+ <v>SvcName = string()</v>
+ <v>Connection = #{peer := term(),
+ wd := term(),
+ peername := Address,
+	 sockname := Address}</v>
+ <v>Address = {inet:ip_address(), inet:port_number()}</v>
+</type>
+<desc>
+
+Return a list of connections associated with the service 'SvcName'. 
+
+</desc>
+</func>
+
+
+
+<func>
+<name since="OTP 25.X">which_transports() -> [Transport]</name>
+<fsummary>Returns a list of transports.</fsummary>
+<type>
+ <v>Transport = #{ref := reference(),
+ type := atom(),
+ service := SvcName}</v>
+ <v>SvcName = string()</v>
+</type>
+<desc>
+
+Return a list of all transports. 
+
+</desc>
+</func>
+
+<func>
+<name since="OTP 25.X">which_transports(SvcName) -> [Transport]</name>
+<fsummary>Returns a list of transports.</fsummary>
+<type>
+ <v>SvcName = string()</v>
+ <v>Transport = #{ref := reference(),
+ type := atom()}</v>
+</type>
+<desc>
+
+Return a list of transports associated with the service 'SvcName'. 
+
+</desc>
+</func>
+
+
+
+<func>
+<name since="OTP 25.X">which_watchdogs() -> [Watchdog]</name>
+<fsummary>Returns a list of watchdogs.</fsummary>
+<type>
+ <v>Watchdog = #{ref := reference(),
+ type := atom(),
+ pid := pid(),
+ state := diameter_service:wd_state(),
+ peer := boolean() | pid(),
+ uptime := {Hours, Mins, Secs, MicroSecs}
+ service := SvcName}</v>
+ <v>SvcName = string()</v>
+</type>
+<desc>
+
+Return a list of all watchdogs. 
+
+</desc>
+</func>
+
+<func>
+<name since="OTP 25.X">which_watchdogs(SvcName) -> [Transport]</name>
+<fsummary>Returns a list of watchdogs.</fsummary>
+<type>
+ <v>SvcName = string()</v>
+ <v>Watchdog = #{ref := reference(),
+ type := atom(),
+ pid := pid(),
+ state := diameter_service:wd_state(),
+ peer := boolean() | pid(),
+ uptime := {Hours, Mins, Secs, MicroSecs}</v>
+</type>
+<desc>
+
+Return a list of watchdogs associated with the service 'SvcName'. 
+
+</desc>
+</func>
+
+
+
 <func>
 <name since="OTP R14B03">service_info(SvcName, Info) -> term()</name>
 <fsummary>Return information about a started service.</fsummary>
-- 
2.35.3

Places

File 7634-diameter-doc-Add-documentation-for-the-which-functio.patch of Package erlang (Revision 22913b88332bf024e9a94e5904b07e48)

Places