Skip to content

Commit b043fe2

Browse files
opensips-githubopensips-github
committed
Rebuild documentation
1 parent 102dcf3 commit b043fe2

61 files changed

Lines changed: 802 additions & 649 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎modules/b2b_entities/README‎

Lines changed: 38 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ B2B_ENTITIES
4545
1.5. Exported MI Functions
4646

4747
1.5.1. b2b_entities:list
48-
1.5.2. ua_session_client_start
49-
1.5.3. ua_session_update
50-
1.5.4. ua_session_reply
51-
1.5.5. ua_session_terminate
52-
1.5.6. ua_session_list
48+
1.5.2. b2b_entities:ua_session_client_start
49+
1.5.3. b2b_entities:ua_session_update
50+
1.5.4. b2b_entities:ua_session_reply
51+
1.5.5. b2b_entities:ua_session_terminate
52+
1.5.6. b2b_entities:ua_session_list
5353

5454
1.6. Exported Events
5555

@@ -323,7 +323,7 @@ modparam("b2b_entities", "passthru_prack", 1)
323323
1.3.14. advertised_contact (str)
324324

325325
Contact to use in generated messages for UA session started
326-
with the ua_session_client_start MI function.
326+
with the b2b_entities:ua_session_client_start MI function.
327327

328328
Example 1.14. Set advertised_contact parameter
329329
...
@@ -335,8 +335,8 @@ modparam("b2b_entities", "advertised_contact", "opensips@10.10.10.10:506
335335

336336
Default timeout, in seconds, for UA session started with the
337337
ua_session_server_init() function or the
338-
ua_session_client_start MI function. After this interval a BYE
339-
will be sent and the session will be deleted.
338+
b2b_entities:ua_session_client_start MI function. After this
339+
interval a BYE will be sent and the session will be deleted.
340340

341341
If not set the default is 43200 (12 hours).
342342

@@ -399,7 +399,7 @@ if(is_method("INVITE") && !has_totag()) {
399399

400400
Sends a sequential request for a UA session started with the
401401
ua_session_server_init() function or the
402-
ua_session_client_start MI function.
402+
b2b_entities:ua_session_client_start MI function.
403403

404404
Parameters:
405405
* key (string) - b2b entity key of the UA session.
@@ -424,7 +424,7 @@ ua_session_update($var(b2b_key), "OPTIONS");
424424

425425
Sends a reply for a UA session started with the
426426
ua_session_server_init() function or the
427-
ua_session_client_start MI function.
427+
b2b_entities:ua_session_client_start MI function.
428428

429429
Parameters:
430430
* key (string) - b2b entity key of the UA session.
@@ -451,7 +451,7 @@ ua_session_reply($var(b2b_key), "INVITE", 180, "Ringing");
451451

452452
Terminate a UA session started with the
453453
ua_session_server_init() function or the
454-
ua_session_client_start MI function.
454+
b2b_entities:ua_session_client_start MI function.
455455

456456
Parameters:
457457
* key (string) - b2b entity key of the UA session.
@@ -481,13 +481,13 @@ ua_session_terminate($var(b2b_key));
481481
MI FIFO Command Format:
482482
opensips-cli -x mi b2b_entities:list
483483

484-
1.5.2. ua_session_client_start
484+
1.5.2. b2b_entities:ua_session_client_start
485485

486486
This command starts a new UAC session by sending an initial
487487
INVITE. Further requests/replies received belonging to this
488488
session will only be handled via the E_UA_SESSION event.
489489

490-
Name: ua_session_client_start
490+
Name: b2b_entities:ua_session_client_start
491491

492492
Parameters:
493493
* ruri - Request URI
@@ -509,16 +509,17 @@ ua_session_terminate($var(b2b_key));
509509
* socket (optional) - OpenSIPS sending socket
510510

511511
opensips-cli Command Format:
512-
opensips-cli -x mi ua_session_client_start ruri=sip:bob@opensips.org \
512+
opensips-cli -x mi b2b_entities:ua_session_client_start ruri=sip:bob@ope
513+
nsips.org \
513514
to=sip:bob@opensips.org from=sip:alice@opensips.org flags=arhb
514515

515-
1.5.3. ua_session_update
516+
1.5.3. b2b_entities:ua_session_update
516517

517518
Sends a sequential request for a UA session started with the
518519
ua_session_server_init() function or the
519-
ua_session_client_start MI function.
520+
b2b_entities:ua_session_client_start MI function.
520521

521-
Name: ua_session_update
522+
Name: b2b_entities:ua_session_update
522523

523524
Parameters:
524525
* key - b2b entity key of the UA session.
@@ -531,16 +532,16 @@ to=sip:bob@opensips.org from=sip:alice@opensips.org flags=arhb
531532
application/sdp" will be used.
532533

533534
opensips-cli Command Format:
534-
opensips-cli -x mi ua_session_update key=B2B.436.1925389.1649338095 meth
535-
od=OPTIONS
535+
opensips-cli -x mi b2b_entities:ua_session_update key=B2B.436.1925389.16
536+
49338095 method=OPTIONS
536537

537-
1.5.4. ua_session_reply
538+
1.5.4. b2b_entities:ua_session_reply
538539

539540
Sends a reply for a UA session started with the
540541
ua_session_server_init() function or the
541-
ua_session_client_start MI function.
542+
b2b_entities:ua_session_client_start MI function.
542543

543-
Name: ua_session_reply
544+
Name: b2b_entities:ua_session_reply
544545

545546
Parameters:
546547
* key - b2b entity key of the UA session.
@@ -555,47 +556,49 @@ od=OPTIONS
555556
application/sdp" will be used.
556557

557558
opensips-cli Command Format:
558-
opensips-cli -x mi ua_session_reply key=B2B.436.1925389.1649338095 metho
559-
d=OPTIONS code=200 reason=OK
559+
opensips-cli -x mi b2b_entities:ua_session_reply key=B2B.436.1925389.164
560+
9338095 method=OPTIONS code=200 reason=OK
560561

561-
1.5.5. ua_session_terminate
562+
1.5.5. b2b_entities:ua_session_terminate
562563

563564
Terminate a UA session started with the
564565
ua_session_server_init() function or the
565-
ua_session_client_start MI function.
566+
b2b_entities:ua_session_client_start MI function.
566567

567-
Name: ua_session_terminate
568+
Name: b2b_entities:ua_session_terminate
568569

569570
Parameters:
570571
* key - b2b entity key of the UA session.
571572
* extra_headers (optional) - extra headers to include in the
572573
SIP message
573574

574575
opensips-cli Command Format:
575-
opensips-cli -x mi ua_session_terminate key=B2B.436.1925389.1649338095
576+
opensips-cli -x mi b2b_entities:ua_session_terminate key=B2B.436.1925389
577+
.1649338095
576578

577-
1.5.6. ua_session_list
579+
1.5.6. b2b_entities:ua_session_list
578580

579581
List information about UA sessions started with
580582
ua_session_server_init() function or the
581-
ua_session_client_start MI function.
583+
b2b_entities:ua_session_client_start MI function.
582584

583-
Name: ua_session_list
585+
Name: b2b_entities:ua_session_list
584586

585587
Parameters:
586588
* key (optional) - b2b entity key of the UA session to list.
587589
If missing, all sessions will be listed.
588590

589591
MI FIFO Command Format:
590-
opensips-cli -x mi ua_session_list
592+
opensips-cli -x mi b2b_entities:ua_session_list
591593

592594
1.6. Exported Events
593595

594596
1.6.1. E_UA_SESSION
595597

596598
This event is triggered for requests/replies belonging to an
597599
ongoing UA session started with the ua_session_server_init()
598-
function or the ua_session_client_start MI function.
600+
function or the b2b_entities:ua_session_client_start MI
601+
function.
599602

600603
Note that replies will not be reported at all unless the r flag
601604
was set when initiating the UA session. Also ACK requests are
@@ -816,7 +819,7 @@ Chapter 3. Contributors
816819
Name DevScore Commits Lines ++ Lines --
817820
1. Anca Vamanu 183 94 6839 1860
818821
2. Vlad Patrascu (@rvlad-patrascu) 128 62 5443 1147
819-
3. Razvan Crainea (@razvancrainea) 106 85 1184 627
822+
3. Razvan Crainea (@razvancrainea) 109 87 1260 651
820823
4. Bogdan-Andrei Iancu (@bogdan-iancu) 69 57 655 309
821824
5. Ovidiu Sas (@ovidiusas) 59 44 990 348
822825
6. Liviu Chircu (@liviuchircu) 22 18 99 128
@@ -851,7 +854,7 @@ Chapter 3. Contributors
851854

852855
Table 3.2. Most recently active contributors^(1) to this module
853856
Name Commit Activity
854-
1. Razvan Crainea (@razvancrainea) Dec 2010 - Jun 2026
857+
1. Razvan Crainea (@razvancrainea) Dec 2010 - Jul 2026
855858
2. Norman Brandinger (@NormB) Jun 2026 - Jun 2026
856859
3. Bogdan-Andrei Iancu (@bogdan-iancu) Aug 2009 - Jun 2026
857860
4. Ovidiu Sas (@ovidiusas) Nov 2010 - Apr 2026

‎modules/b2b_entities/doc/contributors.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
<row>
3838
<entry>3. </entry>
3939
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
40-
<entry align="center">106</entry>
41-
<entry align="center">85</entry>
42-
<entry align="center">1184</entry>
43-
<entry align="center">627</entry>
40+
<entry align="center">109</entry>
41+
<entry align="center">87</entry>
42+
<entry align="center">1260</entry>
43+
<entry align="center">651</entry>
4444
</row>
4545
<row>
4646
<entry>4. </entry>
@@ -129,7 +129,7 @@
129129
<row>
130130
<entry>1. </entry>
131131
<entry>Razvan Crainea (<ulink url="https://github.com/razvancrainea">@razvancrainea</ulink>)</entry>
132-
<entry align="center">Dec 2010 - Jun 2026</entry>
132+
<entry align="center">Dec 2010 - Jul 2026</entry>
133133
</row>
134134
<row>
135135
<entry>2. </entry>

‎modules/b2b_logic/README‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,11 @@ b2b_client_new("client1", "sip:alice@opensips.org");
673673
connected). At least one of the two entities has to be a new
674674
client entity.
675675

676+
When a provmedia_uri is used together with the
677+
provmedia-extra-headers flag, the extra headers configured for
678+
the new client entity through b2b_client_new() are also added
679+
to the INVITE sent to the provisional media server.
680+
676681
Parameters:
677682
* entity1 (string) - ID of the first entity to bridge; the
678683
special values: peer and this can also be used to refer to
@@ -710,6 +715,9 @@ b2b_client_new("client1", "sip:alice@opensips.org");
710715
authentication that requires the stored AVPs for
711716
username and password, but can also be useful to store
712717
other information across the bridge.
718+
+ provmedia-extra-headers - Add the extra headers
719+
configured for the new client entity to the INVITE
720+
sent to the provisional media server.
713721

714722
This function can be used from the b2b_logic request routes.
715723

@@ -1273,6 +1281,12 @@ typedef int (*b2bl_bridge_f)(str* key, str* new_uri, str* new_from_dname
12731281
This function allows bridging an entity that is in a call
12741282
handled by b2b_logic to another entity.
12751283

1284+
Bridge flows preserve the extra headers configured on newly
1285+
created client entities. If provisional media is used while
1286+
bridging, those headers are also passed to the provisional
1287+
media client entity only when the bridge is started with the
1288+
provmedia-extra-headers flag.
1289+
12761290
2.4. bridge_extern
12771291

12781292
Field type:
@@ -1339,19 +1353,19 @@ Chapter 3. Contributors
13391353
commits^(2) and lines added/removed^(3)
13401354
Name DevScore Commits Lines ++ Lines --
13411355
1. Vlad Patrascu (@rvlad-patrascu) 239 57 8167 6793
1342-
2. Razvan Crainea (@razvancrainea) 68 44 1976 409
1356+
2. Razvan Crainea (@razvancrainea) 69 45 2008 419
13431357
3. Bogdan-Andrei Iancu (@bogdan-iancu) 19 14 216 130
13441358
4. Nick Altmann (@nikbyte) 14 10 346 36
13451359
5. Carsten Bock 12 5 679 23
13461360
6. Alexandra Titoc 11 9 14 14
13471361
7. Maksym Sobolyev (@sobomax) 7 5 31 31
13481362
8. Norman Brandinger (@NormB) 6 4 5 5
1349-
9. Liviu Chircu (@liviuchircu) 5 3 4 3
1350-
10. truong.hua 4 2 8 7
1363+
9. Ovidiu Sas (@ovidiusas) 5 3 24 20
1364+
10. Liviu Chircu (@liviuchircu) 5 3 4 3
13511365

1352-
All remaining contributors: andingv, Ovidiu Sas (@ovidiusas),
1353-
Aron Podrigal (@ar45), Rick Barenthin, Shanee Vanstone, Zero
1354-
King (@l2dy), dirkbro.
1366+
All remaining contributors: truong.hua, andingv, Aron Podrigal
1367+
(@ar45), Rick Barenthin, Shanee Vanstone, Zero King (@l2dy),
1368+
dirkbro.
13551369

13561370
(1) DevScore = author_commits + author_lines_added /
13571371
(project_lines_added / project_commits) + author_lines_deleted
@@ -1373,16 +1387,16 @@ Chapter 3. Contributors
13731387

13741388
Table 3.2. Most recently active contributors^(1) to this module
13751389
Name Commit Activity
1376-
1. Razvan Crainea (@razvancrainea) Jan 2021 - Jun 2026
1390+
1. Razvan Crainea (@razvancrainea) Jan 2021 - Jul 2026
13771391
2. Bogdan-Andrei Iancu (@bogdan-iancu) Apr 2021 - Apr 2026
1378-
3. Ovidiu Sas (@ovidiusas) Dec 2025 - Dec 2025
1379-
4. dirkbro Dec 2025 - Dec 2025
1380-
5. andingv Nov 2025 - Nov 2025
1381-
6. Alexandra Titoc Sep 2024 - Sep 2024
1382-
7. Norman Brandinger (@NormB) May 2024 - Jun 2024
1383-
8. Liviu Chircu (@liviuchircu) Nov 2020 - Feb 2024
1384-
9. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
1385-
10. Rick Barenthin Nov 2023 - Nov 2023
1392+
3. dirkbro Dec 2025 - Dec 2025
1393+
4. andingv Nov 2025 - Nov 2025
1394+
5. Alexandra Titoc Sep 2024 - Sep 2024
1395+
6. Norman Brandinger (@NormB) May 2024 - Jun 2024
1396+
7. Liviu Chircu (@liviuchircu) Nov 2020 - Feb 2024
1397+
8. Maksym Sobolyev (@sobomax) Jan 2021 - Nov 2023
1398+
9. Rick Barenthin Nov 2023 - Nov 2023
1399+
10. Ovidiu Sas (@ovidiusas) Dec 2025 - Oct 2023
13861400

13871401
All remaining contributors: Vlad Patrascu (@rvlad-patrascu),
13881402
Shanee Vanstone, truong.hua, Nick Altmann (@nikbyte), Carsten

0 commit comments

Comments
 (0)