Skip to content

Commit

Permalink
Rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@opensips-github
opensips-github committed Nov 4, 2023
1 parent 1df9afd commit f547a7c
Show file tree
Hide file tree
Showing 10 changed files with 130 additions and 82 deletions.
4 changes: 2 additions & 2 deletions modules/b2b_logic/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions modules/b2b_logic/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">23</entry>
<entry align="center">12</entry>
<entry align="center">770</entry>
<entry align="center">24</entry>
<entry align="center">13</entry>
<entry align="center">774</entry>
<entry align="center">226</entry>
</row>
<row>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Jan 2021 - Sep 2023</entry>
<entry align="center">Jan 2021 - Oct 2023</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
53 changes: 43 additions & 10 deletions modules/call_center/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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])
Expand All @@ -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.
Expand All @@ -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")) {
Expand All @@ -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);
Expand Down Expand Up @@ -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");
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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).

Expand Down
8 changes: 4 additions & 4 deletions modules/call_center/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">43</entry>
<entry align="center">33</entry>
<entry align="center">796</entry>
<entry align="center">44</entry>
<entry align="center">34</entry>
<entry align="center">849</entry>
<entry align="center">159</entry>
</row>
<row>
Expand Down Expand Up @@ -190,7 +190,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>).</para>
</section>

</chapter>
16 changes: 8 additions & 8 deletions modules/proto_hep/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:

Expand Down
18 changes: 9 additions & 9 deletions modules/proto_hep/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">36</entry>
<entry align="center">27</entry>
<entry align="center">83</entry>
<entry align="center">486</entry>
<entry align="center">37</entry>
<entry align="center">28</entry>
<entry align="center">84</entry>
<entry align="center">487</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Bence Szigeti</entry>
<entry align="center">Jul 2023 - Aug 2023</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Nov 2015 - Oct 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Nov 2015 - Jul 2023</entry>
<entry>Bence Szigeti</entry>
<entry align="center">Jul 2023 - Aug 2023</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -190,7 +190,7 @@
<title>Documentation</title>
<section id="documentation_contributors" xreflabel="documentation_contributors">
<title>Contributors</title>
<para><emphasis role='bold'>Last edited by:</emphasis> Bence Szigeti, Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>).</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bence Szigeti, Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>).</para>
</section>

</chapter>
28 changes: 14 additions & 14 deletions modules/proto_ws/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
34 changes: 17 additions & 17 deletions modules/proto_ws/doc/contributors.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,10 @@
<row>
<entry>7. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">4</entry>
<entry align="center">2</entry>
<entry align="center">5</entry>
<entry align="center">3</entry>
<entry align="center">5</entry>
<entry align="center">3</entry>
<entry align="center">1</entry>
</row>
<row>
<entry>8. </entry>
Expand Down Expand Up @@ -128,58 +128,58 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>)</entry>
<entry align="center">Mar 2015 - Oct 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Mar 2015 - Sep 2023</entry>
</row>
<row>
<entry>2. </entry>
<entry>3. </entry>
<entry>Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>)</entry>
<entry align="center">Mar 2017 - May 2023</entry>
</row>
<row>
<entry>3. </entry>
<entry>4. </entry>
<entry>James Stanley</entry>
<entry align="center">Mar 2023 - Mar 2023</entry>
</row>
<row>
<entry>4. </entry>
<entry>5. </entry>
<entry>Maksym Sobolyev (<ulink url="https://github.com/sobomax">@sobomax</ulink>)</entry>
<entry align="center">Feb 2017 - Feb 2023</entry>
</row>
<row>
<entry>5. </entry>
<entry>6. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2015 - Apr 2022</entry>
</row>
<row>
<entry>6. </entry>
<entry>7. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Oct 2021</entry>
</row>
<row>
<entry>7. </entry>
<entry>8. </entry>
<entry>Dan Shields</entry>
<entry align="center">Aug 2021 - Aug 2021</entry>
</row>
<row>
<entry>8. </entry>
<entry>9. </entry>
<entry>Nick Altmann (<ulink url="https://github.com/nikbyte">@nikbyte</ulink>)</entry>
<entry align="center">May 2021 - May 2021</entry>
</row>
<row>
<entry>9. </entry>
<entry>10. </entry>
<entry>Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>)</entry>
<entry align="center">Jun 2018 - Jun 2018</entry>
</row>
<row>
<entry>10. </entry>
<entry>Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>)</entry>
<entry align="center">Jul 2015 - Apr 2017</entry>
</row>
</tbody>
</tgroup>
</table>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Julián Moreno Patiño, Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>).</para>
<para><emphasis role='bold'>All remaining contributors</emphasis>: Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Julián Moreno Patiño.</para>
<para>
<emphasis>(1) including any documentation-related commits, excluding merge commits</emphasis>
</para>
Expand Down
Loading

0 comments on commit f547a7c

Please sign in to comment.