Browse code

acc: extend documentation related to flag usage

Henning Westerholt authored on 12/09/2019 19:53:21
Showing 1 changed files
... ...
@@ -489,7 +489,9 @@ modparam("acc", "early_media", 1)
489 489
 		<title><varname>failed_transaction_flag</varname> (integer)</title>
490 490
 		<para>
491 491
 		Per transaction flag which says if the transaction should be
492
-		accounted also in case of failure (status>=300).
492
+		accounted also in case of failure (SIP status code >= 300).
493
+		This flag triggers accouting when the whole transaction fails
494
+		(on the server side).
493 495
 		</para>
494 496
 		<para>
495 497
 		Default value is not-set (no flag).
... ...
@@ -679,12 +681,12 @@ modparam("acc", "log_flag", 2)
679 681
 		<para>
680 682
 		Request flag which needs to be set to account missed calls via syslog.
681 683
 		This can be used to e.g. account failures during the call setup phase
682
-		from the callee side, for example if you do forking to several
684
+		from the callee (client) side, for example if you do forking to several
683 685
 		destinations.
684 686
 		</para>
685 687
 		<para>
686
-		Keep in mind that this flag is reset after processing. Therefore it is
687
-		necessary to set it again e.g. in a failure_route if you do serial
688
+		Keep in mind that this flag is reset after branch completion. Therefore
689
+		it is necessary to set it again e.g. in a failure_route if you do serial
688 690
 		forking and want to log all attempts.
689 691
 		</para>
690 692
 		<para>
... ...
@@ -775,8 +777,15 @@ modparam("acc", "db_flag", 2)
775 777
 	<section id="acc.p.db_missed_flag">
776 778
 		<title><varname>db_missed_flag</varname> (integer)</title>
777 779
 		<para>
778
-		Request flag which needs to be set to account missed
779
-		calls -- database specific.
780
+		Request flag which needs to be set to account missed calls via database.
781
+		This can be used to e.g. account failures during the call setup phase
782
+		from the callee (client) side, for example if you do forking to several
783
+		destinations.
784
+		</para>
785
+		<para>
786
+		Keep in mind that this flag is reset after branch completion. Therefore
787
+		it is necessary to set it again e.g. in a failure_route if you do serial
788
+		forking and want to log all attempts.
780 789
 		</para>
781 790
 		<para>
782 791
 		Default value is not-set (no flag).