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 7, 2020
1 parent b3016f0 commit 5aa38e8
Show file tree
Hide file tree
Showing 12 changed files with 108 additions and 73 deletions.
4 changes: 2 additions & 2 deletions modules/acc/README
View file
Expand Up @@ -1068,7 +1068,7 @@ Chapter 3. Contributors
2. Jan Janak (@janakj) 145 16 5587 5074
3. Ionut Ionita (@ionutrazvanionita) 139 39 3730 4180
4. Razvan Crainea (@razvancrainea) 93 61 2646 566
5. Liviu Chircu (@liviuchircu) 59 45 568 543
5. Liviu Chircu (@liviuchircu) 60 46 585 545
6. Jiri Kuthan (@jiriatipteldotorg) 56 26 2272 660
7. Daniel-Constantin Mierla (@miconda) 26 23 115 88
8. Elena-Ramona Modroiu 24 4 2267 5
Expand Down Expand Up @@ -1104,7 +1104,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jan 2013 - Jun 2020
1. Liviu Chircu (@liviuchircu) Jan 2013 - Sep 2020
2. Razvan Crainea (@razvancrainea) Aug 2010 - Jun 2020
3. Bogdan-Andrei Iancu (@bogdan-iancu) Dec 2003 - May 2020
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Nov 2019
Expand Down
10 changes: 5 additions & 5 deletions modules/acc/doc/contributors.xml
View file
Expand Up @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">59</entry>
<entry align="center">45</entry>
<entry align="center">568</entry>
<entry align="center">543</entry>
<entry align="center">60</entry>
<entry align="center">46</entry>
<entry align="center">585</entry>
<entry align="center">545</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jan 2013 - Jun 2020</entry>
<entry align="center">Jan 2013 - Sep 2020</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
40 changes: 20 additions & 20 deletions modules/dialog/README
View file
Expand Up @@ -1418,9 +1418,9 @@ if ( get_dialogs_by_profile("caller",$fU,$avp(dlg_jsons),$avp(dlg_no)) )

Example 1.60. load_dialog_ctx usage
...
if ( load_dialog_ctx("$var(callid)") ) {
xlog("The dialog $var(callid) has an already duration"
" of $DLG_lifetime seconds \n);
if (load_dialog_ctx("$var(callid)")) {
xlog("The dialog '$var(callid)' already has a duration "
"of $DLG_lifetime seconds\n");
if (is_in_profile("inbound_call"))
xlog("this dialog is an inbound call\n");
unload_dialog_ctx();
Expand Down Expand Up @@ -2474,9 +2474,9 @@ Chapter 4. Contributors
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 434 273 12803 3381
2. Vlad Paiu (@vladpaiu) 252 143 7199 3026
3. Razvan Crainea (@razvancrainea) 239 177 4677 1391
3. Razvan Crainea (@razvancrainea) 240 178 4705 1392
4. Vlad Patrascu (@rvlad-patrascu) 160 81 3401 3114
5. Liviu Chircu (@liviuchircu) 144 103 2744 1091
5. Liviu Chircu (@liviuchircu) 145 104 2747 1094
6. Dan Pascu (@danpascu) 30 25 233 179
7. Ovidiu Sas (@ovidiusas) 28 22 486 110
8. Eseanu Marius Cristian (@eseanucristian) 18 6 722 341
Expand Down Expand Up @@ -2516,9 +2516,9 @@ Chapter 4. Contributors

Table 4.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Ovidiu Sas (@ovidiusas) Feb 2008 - Sep 2020
2. Razvan Crainea (@razvancrainea) Aug 2010 - Aug 2020
3. Liviu Chircu (@liviuchircu) Aug 2012 - Aug 2020
1. Liviu Chircu (@liviuchircu) Aug 2012 - Nov 2020
2. Razvan Crainea (@razvancrainea) Aug 2010 - Nov 2020
3. Ovidiu Sas (@ovidiusas) Feb 2008 - Sep 2020
4. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - Jul 2020
5. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2006 - Jun 2020
6. Vlad Paiu (@vladpaiu) Oct 2010 - Apr 2020
Expand Down Expand Up @@ -2547,18 +2547,18 @@ Chapter 5. Documentation

5.1. Contributors

Last edited by: Vlad Patrascu (@rvlad-patrascu), Razvan Crainea
(@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Vlad
Paiu (@vladpaiu), Zero King (@l2dy), Dan Pascu (@danpascu),
Liviu Chircu (@liviuchircu), Peter Lemenkov (@lemenkov), Julián
Moreno Patiño, Ionut Ionita (@ionutrazvanionita), Ionel Cerghit
(@ionel-cerghit), Walter Doekes (@wdoekes), Eseanu Marius
Cristian (@eseanucristian), Norman Brandinger (@NormB), Anca
Vamanu, Andrei Dragus, Hugues Mitonneau, Klaus Darilion,
Henning Westerholt (@henningw), Ovidiu Sas (@ovidiusas),
Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson
Gellert Schubert, Michel Bensoussan, Andy Pyles, Elena-Ramona
Modroiu.
Last edited by: Liviu Chircu (@liviuchircu), Vlad Patrascu
(@rvlad-patrascu), Razvan Crainea (@razvancrainea),
Bogdan-Andrei Iancu (@bogdan-iancu), Vlad Paiu (@vladpaiu),
Zero King (@l2dy), Dan Pascu (@danpascu), Peter Lemenkov
(@lemenkov), Julián Moreno Patiño, Ionut Ionita
(@ionutrazvanionita), Ionel Cerghit (@ionel-cerghit), Walter
Doekes (@wdoekes), Eseanu Marius Cristian (@eseanucristian),
Norman Brandinger (@NormB), Anca Vamanu, Andrei Dragus, Hugues
Mitonneau, Klaus Darilion, Henning Westerholt (@henningw),
Ovidiu Sas (@ovidiusas), Daniel-Constantin Mierla (@miconda),
Konstantin Bokarius, Edson Gellert Schubert, Michel Bensoussan,
Andy Pyles, Elena-Ramona Modroiu.

Documentation Copyrights:

Expand Down
28 changes: 14 additions & 14 deletions modules/dialog/doc/contributors.xml
View file
Expand Up @@ -37,10 +37,10 @@
<row>
<entry>3. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">239</entry>
<entry align="center">177</entry>
<entry align="center">4677</entry>
<entry align="center">1391</entry>
<entry align="center">240</entry>
<entry align="center">178</entry>
<entry align="center">4705</entry>
<entry align="center">1392</entry>
</row>
<row>
<entry>4. </entry>
Expand All @@ -53,10 +53,10 @@
<row>
<entry>5. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">144</entry>
<entry align="center">103</entry>
<entry align="center">2744</entry>
<entry align="center">1091</entry>
<entry align="center">145</entry>
<entry align="center">104</entry>
<entry align="center">2747</entry>
<entry align="center">1094</entry>
</row>
<row>
<entry>6. </entry>
Expand Down Expand Up @@ -128,18 +128,18 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
<entry align="center">Feb 2008 - Sep 2020</entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Aug 2010 - Aug 2020</entry>
<entry align="center">Aug 2010 - Nov 2020</entry>
</row>
<row>
<entry>3. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Aug 2012 - Aug 2020</entry>
<entry>Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>)</entry>
<entry align="center">Feb 2008 - Sep 2020</entry>
</row>
<row>
<entry>4. </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> Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Dan Pascu (<ulink url="https://github.com/danpascu">@danpascu</ulink>), Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Julián Moreno Patiño, Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>), Norman Brandinger (<ulink url="https://github.com/NormB">@NormB</ulink>), Anca Vamanu, Andrei Dragus, Hugues Mitonneau, Klaus Darilion, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Michel Bensoussan, Andy Pyles, Elena-Ramona Modroiu.</para>
<para><emphasis role='bold'>Last edited by:</emphasis> Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>), Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>), Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>), Bogdan-Andrei Iancu (<ulink url="https://github.com/bogdan-iancu">@bogdan-iancu</ulink>), Vlad Paiu (<ulink url="https://github.com/vladpaiu">@vladpaiu</ulink>), Zero King (<ulink url="https://github.com/l2dy">@l2dy</ulink>), Dan Pascu (<ulink url="https://github.com/danpascu">@danpascu</ulink>), Peter Lemenkov (<ulink url="https://github.com/lemenkov">@lemenkov</ulink>), Julián Moreno Patiño, Ionut Ionita (<ulink url="https://github.com/ionutrazvanionita">@ionutrazvanionita</ulink>), Ionel Cerghit (<ulink url="https://github.com/ionel-cerghit">@ionel-cerghit</ulink>), Walter Doekes (<ulink url="https://github.com/wdoekes">@wdoekes</ulink>), Eseanu Marius Cristian (<ulink url="https://github.com/eseanucristian">@eseanucristian</ulink>), Norman Brandinger (<ulink url="https://github.com/NormB">@NormB</ulink>), Anca Vamanu, Andrei Dragus, Hugues Mitonneau, Klaus Darilion, Henning Westerholt (<ulink url="https://github.com/henningw">@henningw</ulink>), Ovidiu Sas (<ulink url="https://github.com/ovidiusas">@ovidiusas</ulink>), Daniel-Constantin Mierla (<ulink url="https://github.com/miconda">@miconda</ulink>), Konstantin Bokarius, Edson Gellert Schubert, Michel Bensoussan, Andy Pyles, Elena-Ramona Modroiu.</para>
</section>

</chapter>
4 changes: 2 additions & 2 deletions modules/dialplan/README
View file
Expand Up @@ -541,7 +541,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Bogdan-Andrei Iancu (@bogdan-iancu) 61 41 657 852
2. Liviu Chircu (@liviuchircu) 57 36 913 780
2. Liviu Chircu (@liviuchircu) 60 38 954 800
3. Ionut Ionita (@ionutrazvanionita) 40 20 1149 579
4. Anca Vamanu 33 5 3263 19
5. Andrei Dragus 24 3 382 1029
Expand Down Expand Up @@ -576,7 +576,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jul 2012 - Jul 2020
1. Liviu Chircu (@liviuchircu) Jul 2012 - Nov 2020
2. Zero King (@l2dy) Mar 2020 - Mar 2020
3. Razvan Crainea (@razvancrainea) Dec 2010 - Sep 2019
4. Vlad Patrascu (@rvlad-patrascu) May 2017 - Apr 2019
Expand Down
10 changes: 5 additions & 5 deletions modules/dialplan/doc/contributors.xml
View file
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">57</entry>
<entry align="center">36</entry>
<entry align="center">913</entry>
<entry align="center">780</entry>
<entry align="center">60</entry>
<entry align="center">38</entry>
<entry align="center">954</entry>
<entry align="center">800</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jul 2012 - Jul 2020</entry>
<entry align="center">Jul 2012 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
4 changes: 2 additions & 2 deletions modules/mid_registrar/README
View file
Expand Up @@ -1291,7 +1291,7 @@ Chapter 2. Contributors
Table 2.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Liviu Chircu (@liviuchircu) 471 176 15860 10058
1. Liviu Chircu (@liviuchircu) 472 177 15862 10060
2. Vlad Patrascu (@rvlad-patrascu) 9 5 74 126
3. Razvan Crainea (@razvancrainea) 8 6 19 14
4. Bogdan-Andrei Iancu (@bogdan-iancu) 8 5 100 109
Expand Down Expand Up @@ -1320,7 +1320,7 @@ Chapter 2. Contributors

Table 2.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jul 2016 - Jul 2020
1. Liviu Chircu (@liviuchircu) Jul 2016 - Nov 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2017 - Nov 2019
3. Razvan Crainea (@razvancrainea) Mar 2017 - Sep 2019
4. Dan Pascu (@danpascu) May 2019 - May 2019
Expand Down
10 changes: 5 additions & 5 deletions modules/mid_registrar/doc/contributors.xml
View file
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">471</entry>
<entry align="center">176</entry>
<entry align="center">15860</entry>
<entry align="center">10058</entry>
<entry align="center">472</entry>
<entry align="center">177</entry>
<entry align="center">15862</entry>
<entry align="center">10060</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -113,7 +113,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Jul 2016 - Jul 2020</entry>
<entry align="center">Jul 2016 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
4 changes: 2 additions & 2 deletions modules/registrar/README
View file
Expand Up @@ -1373,7 +1373,7 @@ Chapter 3. Contributors
Table 3.1. Top contributors by DevScore^(1), authored
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Liviu Chircu (@liviuchircu) 180 108 2774 2989
1. Liviu Chircu (@liviuchircu) 181 109 2775 2990
2. Bogdan-Andrei Iancu (@bogdan-iancu) 167 113 2382 2031
3. Jan Janak (@janakj) 120 73 3465 1102
4. Daniel-Constantin Mierla (@miconda) 23 19 160 105
Expand Down Expand Up @@ -1416,7 +1416,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Mar 2013 - Sep 2020
1. Liviu Chircu (@liviuchircu) Mar 2013 - Nov 2020
2. Bogdan-Andrei Iancu (@bogdan-iancu) Sep 2003 - Jul 2020
3. Peter Lemenkov (@lemenkov) Jun 2018 - Feb 2020
4. Razvan Crainea (@razvancrainea) Apr 2011 - Sep 2019
Expand Down
10 changes: 5 additions & 5 deletions modules/registrar/doc/contributors.xml
View file
Expand Up @@ -21,10 +21,10 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">180</entry>
<entry align="center">108</entry>
<entry align="center">2774</entry>
<entry align="center">2989</entry>
<entry align="center">181</entry>
<entry align="center">109</entry>
<entry align="center">2775</entry>
<entry align="center">2990</entry>
</row>
<row>
<entry>2. </entry>
Expand Down Expand Up @@ -129,7 +129,7 @@
<row>
<entry>1. </entry>
<entry>Liviu Chircu (<ulink url="https://github.com/liviuchircu">@liviuchircu</ulink>)</entry>
<entry align="center">Mar 2013 - Sep 2020</entry>
<entry align="center">Mar 2013 - Nov 2020</entry>
</row>
<row>
<entry>2. </entry>
Expand Down
47 changes: 41 additions & 6 deletions modules/usrloc/README
View file
Expand Up @@ -1277,21 +1277,56 @@ modparam("usrloc", "contact_refresh_timer", true)

1.9.6. E_UL_CONTACT_REFRESH

This event may only be raised for RFC 8599 (Push Notification)
enabled contacts.

Set contact_refresh_timer to true in order to enable this
event. The event is raised within reasonable time before a
contact binding will expire, such that the script writer can
take action, possibly force a registration refresh from the
event. The event is raised within reasonable time before an RFC
8599 enabled contact will expire, such that the script writer
can take action, possibly force a registration refresh from the
endpoint.

Parameters:
* all E_UL_CONTACT_INSERT event parameters
* domain - The name of the table.
* aor - The AOR of the inserted contact.
* uri - The contact URI of the inserted contact.
* received - IP, port and protocol the registration message
was received from. If these have the same value as the
contact's address (see the address parameter) then the
received parameter will be an empty string.
* user_agent - The User-Agent header value.
NOTICE: Can contain spaces.
* socket - The SIP socket/listener (as string) used by
OpenSIPS to receive the contact registations.
* bflags - The branch flags (bflags) of the contact (in
integer value of the bitmask)
* expires - The expires value of the contact (as UNIX
timestamp integer).
* callid - The Call-ID header of the registration message.
* attr - The attributes string attached to the contact (the
custom attributes attached from the script level). As this
string is options, if missing in the contact, the event
will push the empty string for this event field.
* shtag - The shared tag of the contact, which helps
determine if the current node owns the contact (e.g.
possibly using the $cluster.sh_tag pseudo-variable in order
to perform the check).
* reason - the reason why the binding refresh event was
triggered. Possible values:
+ "reg-refresh" - periodic refresh triggered by OpenSIPS
+ "ini-INVITE", "ini-SUBSCRIBE", etc. - a refresh
triggered by an incoming initial SIP request
+ "mid-INVITE", "mid-BYE", etc. - a refresh triggered by
an incoming mid-dialog SIP request
* req_callid - the Call-ID of the SIP request which triggered
this event, if any. This gives the ability to logically
link the pending request with the current event and access
useful data from that request (e.g. caller identity, dialed
number, etc.).
Using the req_callid, if a dialog has been created for the
pending request, this dialog may be temporarily loaded
inside the event_route using the load_dialog_ctx() and
unload_dialog_ctx() functions of the dialog module.

1.9.7. E_UL_LATENCY_UPDATE

Expand Down Expand Up @@ -1542,7 +1577,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Jan Janak (@janakj) 410 117 15689 10095
2. Liviu Chircu (@liviuchircu) 300 180 8050 3276
2. Liviu Chircu (@liviuchircu) 309 183 8468 3449
3. Bogdan-Andrei Iancu (@bogdan-iancu) 242 148 4208 3614
4. Daniel-Constantin Mierla (@miconda) 40 29 544 308
5. Ionut Ionita (@ionutrazvanionita) 40 24 1099 413
Expand Down Expand Up @@ -1586,7 +1621,7 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Liviu Chircu (@liviuchircu) Jan 2013 - Sep 2020
1. Liviu Chircu (@liviuchircu) Jan 2013 - Nov 2020
2. Walter Doekes (@wdoekes) Apr 2019 - Sep 2020
3. Vlad Patrascu (@rvlad-patrascu) Jul 2016 - May 2020
4. Bogdan-Andrei Iancu (@bogdan-iancu) Mar 2002 - May 2020
Expand Down

0 comments on commit 5aa38e8

Please sign in to comment.