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 Jan 15, 2022
1 parent b1fed3e commit 5f17be1
Show file tree
Hide file tree
Showing 24 changed files with 358 additions and 248 deletions.
71 changes: 48 additions & 23 deletions modules/b2b_entities/README
View file
Expand Up @@ -18,11 +18,13 @@ B2B_ENTITIES
1.3.3. script_req_route (str)
1.3.4. script_reply_route (str)
1.3.5. db_url (str)
1.3.6. update_period (int)
1.3.7. b2b_key_prefix (string)
1.3.8. db_mode (int)
1.3.9. db_table (str)
1.3.10. cluster_id (int)
1.3.6. cachedb_url (str)
1.3.7. cachedb_key_prefix (string)
1.3.8. update_period (int)
1.3.9. b2b_key_prefix (string)
1.3.10. db_mode (int)
1.3.11. db_table (str)
1.3.12. cluster_id (int)

1.4. Exported Functions
1.5. Exported MI Functions
Expand Down Expand Up @@ -63,11 +65,13 @@ B2B_ENTITIES
1.3. Set script_req_route parameter
1.4. Set script_repl_route parameter
1.5. Set db_url parameter
1.6. Set update_period parameter
1.7. Set b2b_key_prefix parameter
1.8. Set db_mode parameter
1.9. Set db_table parameter
1.10. Set cluster_id parameter
1.6. Set cachedb_url parameter
1.7. Set cachedb_key_prefix parameter
1.8. Set update_period parameter
1.9. Set b2b_key_prefix parameter
1.10. Set db_mode parameter
1.11. Set db_table parameter
1.12. Set cluster_id parameter
2.1. b2b_api_t structure

Chapter 1. Admin Guide
Expand Down Expand Up @@ -172,18 +176,39 @@ modparam("b2b_entities", "db_url", "mysql://opensips:opensipsrw@127.0.0.
1/opensips")
...

1.3.6. update_period (int)
1.3.6. cachedb_url (str)

URL of a NoSQL database to be used. Only Redis is supported at
the moment.

Example 1.6. Set cachedb_url parameter
...
modparam("b2b_entities", "cachedb_url", "redis://localhost:6379/")
...

1.3.7. cachedb_key_prefix (string)

Prefix to use for every key set in the NoSQL database.

Default value is “b2be$”.

Example 1.7. Set cachedb_key_prefix parameter
...
modparam("b2b_entities", "cachedb_key_prefix", "b2b")
...

1.3.8. update_period (int)

The time interval at which to update the info in database.

Default value is “100”.

Example 1.6. Set update_period parameter
Example 1.8. Set update_period parameter
...
modparam("b2b_entities", "update_period", 60)
...

1.3.7. b2b_key_prefix (string)
1.3.9. b2b_key_prefix (string)

The string to use when generating the key ( it is inserted in
the SIP messages as callid or to tag. It is useful to set this
Expand All @@ -194,12 +219,12 @@ modparam("b2b_entities", "update_period", 60)

Default value is “B2B”.

Example 1.7. Set b2b_key_prefix parameter
Example 1.9. Set b2b_key_prefix parameter
...
modparam("b2b_entities", "b2b_key_prefix", "B2B1")
...

1.3.8. db_mode (int)
1.3.10. db_mode (int)

The B2B modules have support for the 3 type of database storage

Expand All @@ -211,24 +236,24 @@ modparam("b2b_entities", "b2b_key_prefix", "B2B1")

Default value is “2” (WRITE BACK).

Example 1.8. Set db_mode parameter
Example 1.10. Set db_mode parameter
...
modparam("b2b_entities", "db_mode", 1)
...

1.3.9. db_table (str)
1.3.11. db_table (str)

The name of the table that will be used for storing B2B
entities

Default value is “b2b_entities”

Example 1.9. Set db_table parameter
Example 1.11. Set db_table parameter
...
modparam("b2b_entities", "db_table", "some table name")
...

1.3.10. cluster_id (int)
1.3.12. cluster_id (int)

The ID of the cluster this instance belongs to. Setting this
parameter enables clustering support for the OpenSIPS B2BUA by
Expand All @@ -238,7 +263,7 @@ modparam("b2b_entities", "db_table", "some table name")

Default value is “0” (clustering disabled)

Example 1.10. Set cluster_id parameter
Example 1.12. Set cluster_id parameter
...
modparam("b2b_entities", "cluster_id", 10)
...
Expand Down Expand Up @@ -446,7 +471,7 @@ Chapter 3. Contributors
commits^(2) and lines added/removed^(3)
Name DevScore Commits Lines ++ Lines --
1. Anca Vamanu 181 94 6839 1860
2. Vlad Patrascu (@rvlad-patrascu) 70 40 2205 706
2. Vlad Patrascu (@rvlad-patrascu) 79 41 2846 850
3. Ovidiu Sas (@ovidiusas) 51 39 853 291
4. Bogdan-Andrei Iancu (@bogdan-iancu) 50 43 410 144
5. Razvan Crainea (@razvancrainea) 45 41 236 121
Expand Down Expand Up @@ -481,8 +506,8 @@ Chapter 3. Contributors

Table 3.2. Most recently active contributors^(1) to this module
Name Commit Activity
1. Razvan Crainea (@razvancrainea) Dec 2010 - Nov 2021
2. Vlad Patrascu (@rvlad-patrascu) May 2017 - Sep 2021
1. Vlad Patrascu (@rvlad-patrascu) May 2017 - Jan 2022
2. Razvan Crainea (@razvancrainea) Dec 2010 - Nov 2021
3. Nick Altmann (@nikbyte) Jan 2013 - May 2021
4. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Apr 2021
5. Maksym Sobolyev (@sobomax) Jan 2021 - Mar 2021
Expand Down
16 changes: 8 additions & 8 deletions modules/b2b_entities/doc/contributors.xml
View file
Expand Up @@ -29,10 +29,10 @@
<row>
<entry>2. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">70</entry>
<entry align="center">40</entry>
<entry align="center">2205</entry>
<entry align="center">706</entry>
<entry align="center">79</entry>
<entry align="center">41</entry>
<entry align="center">2846</entry>
<entry align="center">850</entry>
</row>
<row>
<entry>3. </entry>
Expand Down Expand Up @@ -128,13 +128,13 @@
<tbody>
<row>
<entry>1. </entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Nov 2021</entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Jan 2022</entry>
</row>
<row>
<entry>2. </entry>
<entry>Vlad Patrascu (<ulink url="https://github.com/rvlad-patrascu">@rvlad-patrascu</ulink>)</entry>
<entry align="center">May 2017 - Sep 2021</entry>
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
<entry align="center">Dec 2010 - Nov 2021</entry>
</row>
<row>
<entry>3. </entry>
Expand Down

0 comments on commit 5f17be1

Please sign in to comment.