From f547a7c07bcf53874705bdae79a5ae2156b28f2c Mon Sep 17 00:00:00 2001 From: OpenSIPS Date: Sun, 5 Nov 2023 01:31:24 +0200 Subject: [PATCH] Rebuild documentation --- modules/b2b_logic/README | 4 +- modules/b2b_logic/doc/contributors.xml | 8 ++-- modules/call_center/README | 53 +++++++++++++++++++----- modules/call_center/doc/contributors.xml | 8 ++-- modules/proto_hep/README | 16 +++---- modules/proto_hep/doc/contributors.xml | 18 ++++---- modules/proto_ws/README | 28 ++++++------- modules/proto_ws/doc/contributors.xml | 34 +++++++-------- modules/tls_wolfssl/README | 18 ++++---- modules/tls_wolfssl/doc/contributors.xml | 25 ++++++++--- 10 files changed, 130 insertions(+), 82 deletions(-) diff --git a/modules/b2b_logic/README b/modules/b2b_logic/README index 3ea8f276653..c3d5a45a068 100644 --- a/modules/b2b_logic/README +++ b/modules/b2b_logic/README @@ -1240,7 +1240,7 @@ Chapter 3. Contributors commits^(2) and lines added/removed^(3) Name DevScore Commits Lines ++ Lines -- 1. Vlad Patrascu (@rvlad-patrascu) 235 57 8167 6793 - 2. Razvan Crainea (@razvancrainea) 23 12 770 226 + 2. Razvan Crainea (@razvancrainea) 24 13 774 226 3. Nick Altmann (@nikbyte) 14 10 346 36 4. Carsten Bock 12 5 679 23 5. Bogdan-Andrei Iancu (@bogdan-iancu) 11 7 143 64 @@ -1272,7 +1272,7 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Razvan Crainea (@razvancrainea) Jan 2021 - Sep 2023 + 1. Razvan Crainea (@razvancrainea) Jan 2021 - Oct 2023 2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2021 - Sep 2023 3. Vlad Patrascu (@rvlad-patrascu) Nov 2020 - Jul 2023 4. Shanee Vanstone Apr 2023 - Apr 2023 diff --git a/modules/b2b_logic/doc/contributors.xml b/modules/b2b_logic/doc/contributors.xml index 2f6c07967fd..b2e5532073f 100644 --- a/modules/b2b_logic/doc/contributors.xml +++ b/modules/b2b_logic/doc/contributors.xml @@ -29,9 +29,9 @@ 2. Razvan Crainea (@razvancrainea) - 23 - 12 - 770 + 24 + 13 + 774 226 @@ -129,7 +129,7 @@ 1. Razvan Crainea (@razvancrainea) - Jan 2021 - Sep 2023 + Jan 2021 - Oct 2023 2. diff --git a/modules/call_center/README b/modules/call_center/README index 295c5840c43..b129d2fcaab 100644 --- a/modules/call_center/README +++ b/modules/call_center/README @@ -50,6 +50,7 @@ Call-Center Module 1.4.29. ccf_m_queue_column (string) 1.4.30. ccf_m_dissuading_column (string) 1.4.31. ccf_m_flow_id_column (string) + 1.4.32. b2b_logic_ctx_param (string) 1.5. Exported Functions @@ -134,9 +135,10 @@ Call-Center Module 1.29. Set ccf_m_queue_column parameter 1.30. Set ccf_m_dissuading_column parameter 1.31. Set ccf_m_flow_id_column parameter - 1.32. cc_handle_call usage - 1.33. cc_agent_login usage - 1.34. $rtpquery Usage + 1.32. Set b2b_logic_ctx_param parameter + 1.33. cc_handle_call usage + 1.34. cc_agent_login usage + 1.35. $rtpquery Usage Chapter 1. Admin Guide @@ -691,6 +693,35 @@ modparam("call_center", "ccf_m_dissuading_column", "audio_dissuading") modparam("call_center", "ccf_m_flow_id_column", "audio_flow_id") ... +1.4.32. b2b_logic_ctx_param (string) + + The name of the $b2b_logic.ctx variable that can be used to + retrieve the value of the parameter passed to the + cc_handle_call function. + + This parameter will be copied throughout all the B2B scenarios + started by the call_center module. NOTE that you can change the + value of the current scenario by writing into it, but the + change will not be reflected in a different scenario. + + Default value is “call_center”. + + Example 1.32. Set b2b_logic_ctx_param parameter +... +modparam("call_center", "b2b_logic_ctx_param", "b2b_callid") +... +route[handle_call_center] { + ... + cc_handle_call("flow", $ci); + ... +} +... +route[b2b_handle_request] { + ... + xlog("Initial Callid is $b2b_logic.ctx(b2b_callid)\n"); + ... +} + 1.5. Exported Functions 1.5.1. cc_handle_call( flowID [,param]) @@ -709,7 +740,9 @@ modparam("call_center", "ccf_m_flow_id_column", "audio_flow_id") is intended for custom integration of the call center module and it is 100% up to the script writer about the value and purpose of this parameter, OpenSIPS will not - touch or interpret it. + touch or interpret it. You can retrieve the value of this + parameter using the $b2b_logic.ctx variable with the name + defined in the b2b_logic_ctx_param parameter. The function returns TRUE back to the script if the call was successfully pushed and handled by the Call Center engine. @@ -724,7 +757,7 @@ modparam("call_center", "ccf_m_flow_id_column", "audio_flow_id") * -4 - no agents logged in the flow; * -5 - internal error; - Example 1.32. cc_handle_call usage + Example 1.33. cc_handle_call usage ... if (is_method("INVITE") and !has_totag()) { if (!cc_handle_call("tech_support")) { @@ -745,7 +778,7 @@ if (is_method("INVITE") and !has_totag()) { * state (int) - an integer value giving the new state - 0 means logged off, anything else means logged in. - Example 1.33. cc_agent_login usage + Example 1.34. cc_agent_login usage ... # log off the 'agentX' agent cc_agent_login("agentX",0); @@ -1032,7 +1065,7 @@ opensips-cli -x mi cc_reset_stats * preagent - the agent is being called. * toagent - the agent is in call. - Example 1.34. $rtpquery Usage + Example 1.35. $rtpquery Usage ... $json(reply) := $rtpquery; xlog("Total RTP Stats: $json(reply/totals)\n"); @@ -1087,7 +1120,7 @@ Chapter 4. Contributors commits^(2) and lines added/removed^(3) Name DevScore Commits Lines ++ Lines -- 1. Bogdan-Andrei Iancu (@bogdan-iancu) 109 44 6780 511 - 2. Razvan Crainea (@razvancrainea) 43 33 796 159 + 2. Razvan Crainea (@razvancrainea) 44 34 849 159 3. Vlad Patrascu (@rvlad-patrascu) 18 9 287 314 4. Liviu Chircu (@liviuchircu) 14 11 72 89 5. Maksym Sobolyev (@sobomax) 5 3 7 12 @@ -1135,8 +1168,8 @@ Chapter 5. Documentation 5.1. Contributors - Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Razvan - Crainea (@razvancrainea), Vlad Patrascu (@rvlad-patrascu), Zero + Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei + Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Zero King (@l2dy), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu). diff --git a/modules/call_center/doc/contributors.xml b/modules/call_center/doc/contributors.xml index c8f30afd578..d6a7d6f973a 100644 --- a/modules/call_center/doc/contributors.xml +++ b/modules/call_center/doc/contributors.xml @@ -29,9 +29,9 @@ 2. Razvan Crainea (@razvancrainea) - 43 - 33 - 796 + 44 + 34 + 849 159 @@ -190,7 +190,7 @@ Documentation
Contributors - Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Razvan Crainea (@razvancrainea), Vlad Patrascu (@rvlad-patrascu), Zero King (@l2dy), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu). + Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Patrascu (@rvlad-patrascu), Zero King (@l2dy), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu).
diff --git a/modules/proto_hep/README b/modules/proto_hep/README index a4d97c59994..735704d3ce7 100644 --- a/modules/proto_hep/README +++ b/modules/proto_hep/README @@ -272,7 +272,7 @@ modparam("proto_hep", "hep_async_local_connect_timeout", 200) Example 1.11. Set hep_async_local_write_timeout parameter ... -modparam("proto_hep", "tcp_async_local_write_timeout", 100) +modparam("proto_hep", "hep_async_local_write_timeout", 100) ... 1.4. Exported Functions @@ -351,7 +351,7 @@ Chapter 3. Contributors commits^(2) and lines added/removed^(3) Name DevScore Commits Lines ++ Lines -- 1. Ionut Ionita (@ionutrazvanionita) 149 66 8047 998 - 2. Razvan Crainea (@razvancrainea) 36 27 83 486 + 2. Razvan Crainea (@razvancrainea) 37 28 84 487 3. Bogdan-Andrei Iancu (@bogdan-iancu) 26 19 384 170 4. Liviu Chircu (@liviuchircu) 18 15 81 92 5. Bence Szigeti 9 2 405 180 @@ -383,8 +383,8 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Bence Szigeti Jul 2023 - Aug 2023 - 2. Razvan Crainea (@razvancrainea) Nov 2015 - Jul 2023 + 1. Razvan Crainea (@razvancrainea) Nov 2015 - Oct 2023 + 2. Bence Szigeti Jul 2023 - Aug 2023 3. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 4. Liviu Chircu (@liviuchircu) Mar 2016 - Oct 2022 5. Nick Altmann (@nikbyte) May 2021 - May 2021 @@ -403,10 +403,10 @@ Chapter 4. Documentation 4.1. Contributors - Last edited by: Bence Szigeti, Bogdan-Andrei Iancu - (@bogdan-iancu), Liviu Chircu (@liviuchircu), Razvan Crainea - (@razvancrainea), Vlad Patrascu (@rvlad-patrascu), Peter - Lemenkov (@lemenkov), Ionut Ionita (@ionutrazvanionita). + Last edited by: Razvan Crainea (@razvancrainea), Bence Szigeti, + Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu + (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov + (@lemenkov), Ionut Ionita (@ionutrazvanionita). Documentation Copyrights: diff --git a/modules/proto_hep/doc/contributors.xml b/modules/proto_hep/doc/contributors.xml index 66d30c0da72..2844d363767 100644 --- a/modules/proto_hep/doc/contributors.xml +++ b/modules/proto_hep/doc/contributors.xml @@ -29,10 +29,10 @@ 2. Razvan Crainea (@razvancrainea) - 36 - 27 - 83 - 486 + 37 + 28 + 84 + 487 3. @@ -128,13 +128,13 @@ 1. - Bence Szigeti - Jul 2023 - Aug 2023 + Razvan Crainea (@razvancrainea) + Nov 2015 - Oct 2023 2. - Razvan Crainea (@razvancrainea) - Nov 2015 - Jul 2023 + Bence Szigeti + Jul 2023 - Aug 2023 3. @@ -190,7 +190,7 @@ Documentation
Contributors - Last edited by: Bence Szigeti, Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Razvan Crainea (@razvancrainea), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Ionut Ionita (@ionutrazvanionita). + Last edited by: Razvan Crainea (@razvancrainea), Bence Szigeti, Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov (@lemenkov), Ionut Ionita (@ionutrazvanionita).
diff --git a/modules/proto_ws/README b/modules/proto_ws/README index 74b881cdecc..d18405d9aac 100644 --- a/modules/proto_ws/README +++ b/modules/proto_ws/README @@ -295,7 +295,7 @@ Chapter 3. Contributors 4. Liviu Chircu (@liviuchircu) 16 11 128 141 5. Vlad Patrascu (@rvlad-patrascu) 8 5 97 74 6. Maksym Sobolyev (@sobomax) 6 4 12 11 - 7. Vlad Paiu (@vladpaiu) 4 2 3 1 + 7. Vlad Paiu (@vladpaiu) 5 3 5 3 8. Nick Altmann (@nikbyte) 3 1 4 4 9. Dan Shields 3 1 4 2 10. Peter Lemenkov (@lemenkov) 3 1 2 2 @@ -323,19 +323,19 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Razvan Crainea (@razvancrainea) Mar 2015 - Sep 2023 - 2. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2017 - May 2023 - 3. James Stanley Mar 2023 - Mar 2023 - 4. Maksym Sobolyev (@sobomax) Feb 2017 - Feb 2023 - 5. Liviu Chircu (@liviuchircu) Mar 2015 - Apr 2022 - 6. Vlad Patrascu (@rvlad-patrascu) May 2017 - Oct 2021 - 7. Dan Shields Aug 2021 - Aug 2021 - 8. Nick Altmann (@nikbyte) May 2021 - May 2021 - 9. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 - 10. Ionut Ionita (@ionutrazvanionita) Jul 2015 - Apr 2017 - - All remaining contributors: Julián Moreno Patiño, Vlad Paiu - (@vladpaiu). + 1. Vlad Paiu (@vladpaiu) Mar 2015 - Oct 2023 + 2. Razvan Crainea (@razvancrainea) Mar 2015 - Sep 2023 + 3. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2017 - May 2023 + 4. James Stanley Mar 2023 - Mar 2023 + 5. Maksym Sobolyev (@sobomax) Feb 2017 - Feb 2023 + 6. Liviu Chircu (@liviuchircu) Mar 2015 - Apr 2022 + 7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Oct 2021 + 8. Dan Shields Aug 2021 - Aug 2021 + 9. Nick Altmann (@nikbyte) May 2021 - May 2021 + 10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 + + All remaining contributors: Ionut Ionita (@ionutrazvanionita), + Julián Moreno Patiño. (1) including any documentation-related commits, excluding merge commits diff --git a/modules/proto_ws/doc/contributors.xml b/modules/proto_ws/doc/contributors.xml index 4552e15b6f6..769ccac6bfa 100644 --- a/modules/proto_ws/doc/contributors.xml +++ b/modules/proto_ws/doc/contributors.xml @@ -69,10 +69,10 @@ 7. Vlad Paiu (@vladpaiu) - 4 - 2 + 5 + 3 + 5 3 - 1 8. @@ -128,58 +128,58 @@ 1. + Vlad Paiu (@vladpaiu) + Mar 2015 - Oct 2023 + + + 2. Razvan Crainea (@razvancrainea) Mar 2015 - Sep 2023 - 2. + 3. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2017 - May 2023 - 3. + 4. James Stanley Mar 2023 - Mar 2023 - 4. + 5. Maksym Sobolyev (@sobomax) Feb 2017 - Feb 2023 - 5. + 6. Liviu Chircu (@liviuchircu) Mar 2015 - Apr 2022 - 6. + 7. Vlad Patrascu (@rvlad-patrascu) May 2017 - Oct 2021 - 7. + 8. Dan Shields Aug 2021 - Aug 2021 - 8. + 9. Nick Altmann (@nikbyte) May 2021 - May 2021 - 9. + 10. Peter Lemenkov (@lemenkov) Jun 2018 - Jun 2018 - - 10. - Ionut Ionita (@ionutrazvanionita) - Jul 2015 - Apr 2017 - -All remaining contributors: Julián Moreno Patiño, Vlad Paiu (@vladpaiu). +All remaining contributors: Ionut Ionita (@ionutrazvanionita), Julián Moreno Patiño. (1) including any documentation-related commits, excluding merge commits diff --git a/modules/tls_wolfssl/README b/modules/tls_wolfssl/README index f00527a1137..58ac36cceb1 100644 --- a/modules/tls_wolfssl/README +++ b/modules/tls_wolfssl/README @@ -96,8 +96,9 @@ Chapter 3. Contributors 2. Razvan Crainea (@razvancrainea) 11 7 206 65 3. Maksym Sobolyev (@sobomax) 4 2 2 2 4. Bogdan-Andrei Iancu (@bogdan-iancu) 3 1 3 3 - 5. Bence Szigeti 3 1 1 1 - 6. Alexey Vasilyev (@vasilevalex) 2 1 11 0 + 5. Liviu Chircu (@liviuchircu) 3 1 2 2 + 6. Bence Szigeti 3 1 1 1 + 7. Alexey Vasilyev (@vasilevalex) 2 1 11 0 (1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted @@ -119,12 +120,13 @@ Chapter 3. Contributors Table 3.2. Most recently active contributors^(1) to this module Name Commit Activity - 1. Bence Szigeti Oct 2023 - Oct 2023 - 2. Razvan Crainea (@razvancrainea) Aug 2023 - Oct 2023 - 3. Bogdan-Andrei Iancu (@bogdan-iancu) May 2023 - May 2023 - 4. Vlad Patrascu (@rvlad-patrascu) May 2021 - Mar 2023 - 5. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 - 6. Alexey Vasilyev (@vasilevalex) Jan 2022 - Jan 2022 + 1. Liviu Chircu (@liviuchircu) Oct 2023 - Oct 2023 + 2. Bence Szigeti Oct 2023 - Oct 2023 + 3. Razvan Crainea (@razvancrainea) Aug 2023 - Oct 2023 + 4. Bogdan-Andrei Iancu (@bogdan-iancu) May 2023 - May 2023 + 5. Vlad Patrascu (@rvlad-patrascu) May 2021 - Mar 2023 + 6. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 + 7. Alexey Vasilyev (@vasilevalex) Jan 2022 - Jan 2022 (1) including any documentation-related commits, excluding merge commits diff --git a/modules/tls_wolfssl/doc/contributors.xml b/modules/tls_wolfssl/doc/contributors.xml index 4d441ed5e23..adec3f41042 100644 --- a/modules/tls_wolfssl/doc/contributors.xml +++ b/modules/tls_wolfssl/doc/contributors.xml @@ -52,6 +52,14 @@ 5. + Liviu Chircu (@liviuchircu) + 3 + 1 + 2 + 2 + + + 6. Bence Szigeti 3 1 @@ -59,7 +67,7 @@ 1 - 6. + 7. Alexey Vasilyev (@vasilevalex) 2 1 @@ -96,31 +104,36 @@ 1. - Bence Szigeti + Liviu Chircu (@liviuchircu) Oct 2023 - Oct 2023 2. + Bence Szigeti + Oct 2023 - Oct 2023 + + + 3. Razvan Crainea (@razvancrainea) Aug 2023 - Oct 2023 - 3. + 4. Bogdan-Andrei Iancu (@bogdan-iancu) May 2023 - May 2023 - 4. + 5. Vlad Patrascu (@rvlad-patrascu) May 2021 - Mar 2023 - 5. + 6. Maksym Sobolyev (@sobomax) Feb 2023 - Feb 2023 - 6. + 7. Alexey Vasilyev (@vasilevalex) Jan 2022 - Jan 2022