Browse code

presence: added section ids for parameters and functions

Daniel-Constantin Mierla authored on 26/03/2015 20:03:40
Showing 1 changed files
... ...
@@ -81,7 +81,7 @@
81 81
 	
82 82
 	<section>
83 83
 	<title>Parameters</title>
84
-	<section>
84
+	<section id="presence.p.db_url">
85 85
 		<title><varname>db_url</varname>(str)</title>
86 86
 		<para>
87 87
 		The database url.
... ...
@@ -103,7 +103,7 @@ modparam("presence", "db_url",
103 103
 </programlisting>
104 104
 		</example>
105 105
 	</section>
106
-	<section>
106
+	<section id="presence.p.presentity_table">
107 107
 		<title><varname>presentity_table</varname>(str)</title>
108 108
 		<para>
109 109
 		The name of the db table where PUBLISH presence information is stored.
... ...
@@ -121,7 +121,7 @@ modparam("presence", "presentity_table", "presentity")
121 121
 </programlisting>
122 122
 		</example>
123 123
 	</section>
124
-	<section>
124
+	<section id="presence.p.active_watchers_table">
125 125
 		<title><varname>active_watchers_table</varname>(str)</title>
126 126
 		<para>
127 127
 		The name of the db table where active subscription information is stored. 
... ...
@@ -139,7 +139,7 @@ modparam("presence", "active_watchers_table", "active_watchers")
139 139
 </programlisting>
140 140
 		</example>
141 141
 	</section>
142
-	<section>
142
+	<section id="presence.p.watchers_table">
143 143
 		<title><varname>watchers_table</varname>(str)</title>
144 144
 		<para>
145 145
 		The name of the db table where subscription states are stored.
... ...
@@ -157,7 +157,7 @@ modparam("presence", "watchers_table", "watchers")
157 157
 </programlisting>
158 158
 		</example>
159 159
 	</section>
160
-	<section>
160
+	<section id="presence.p.clean_period">
161 161
 		<title><varname>clean_period</varname> (int)</title>
162 162
 		<para>
163 163
 		The period in seconds between checks if there are expired messages stored in database.
... ...
@@ -175,7 +175,7 @@ modparam("presence", "clean_period", 100)
175 175
 </programlisting>
176 176
 		</example>
177 177
 	</section>
178
-	<section>
178
+	<section id="presence.p.db_update_period">
179 179
 		<title><varname>db_update_period</varname> (int)</title>
180 180
 		<para>
181 181
 		The period at which to synchronize cached subscriber info with the
... ...
@@ -195,7 +195,7 @@ modparam("presence", "db_update_period", 100)
195 195
 		</example>
196 196
 	</section>
197 197
 
198
-	<section>
198
+	<section id="presence.p.waitn_time">
199 199
 		<title><varname>waitn_time</varname> (int)</title>
200 200
 		<para>
201 201
 		The maximum time period that NOTIFY requests will
... ...
@@ -221,7 +221,7 @@ modparam("presence", "waitn_time", 10)
221 221
 		</example>
222 222
 	</section>
223 223
 
224
-	<section>
224
+	<section id="presence.p.notifier_poll_rate">
225 225
 		<title><varname>notifier_poll_rate</varname> (int)</title>
226 226
 		<para>
227 227
 		The number of times per second that the notifier processes
... ...
@@ -247,7 +247,7 @@ modparam("presence", "notifier_poll_rate", 20)
247 247
 		</example>
248 248
 	</section>
249 249
 
250
-	<section>
250
+	<section id="presence.p.notifier_processes">
251 251
 		<title><varname>notifier_processes</varname> (int)</title>
252 252
 		<para>
253 253
 		The number of notifier processes that should be started.
... ...
@@ -278,7 +278,7 @@ modparam("presence", "notifier_processes", 2)
278 278
 		</example>
279 279
 	</section>
280 280
 
281
-	<section>
281
+	<section id="presence.p.to_tag_pref">
282 282
 		<title><varname>to_tag_pref</varname> (str)</title>
283 283
 		<para>
284 284
 		The prefix used when generating to_tag when sending replies for
... ...
@@ -298,7 +298,7 @@ modparam("presence", "to_tag_pref", 'pres')
298 298
 		</example>
299 299
 	</section>
300 300
 
301
-	<section>
301
+	<section id="presence.p.expires_offset">
302 302
 		<title><varname>expires_offset</varname> (int)</title>
303 303
 		<para>
304 304
 		The value in seconds that should be subtracted from the expires value when
... ...
@@ -319,7 +319,7 @@ modparam("presence", "expires_offset", 10)
319 319
 		</example>
320 320
 
321 321
 </section>
322
-       <section>
322
+       <section id="presence.p.max_expires">
323 323
                <title><varname>max_expires</varname> (int)</title>
324 324
                <para>
325 325
                The maximum admissible expires value for PUBLISH/SUBSCRIBE
... ...
@@ -339,7 +339,7 @@ modparam("presence", "max_expires", 3600)
339 339
 	</example>
340 340
 </section>
341 341
 
342
-<section>
342
+<section id="presence.p.min_expires">
343 343
     <title><varname>min_expires</varname> (int)</title>
344 344
     <para>
345 345
         The minimum admissible expires value for PUBLISH/SUBSCRIBE
... ...
@@ -362,7 +362,7 @@ modparam("presence", "max_expires", 3600)
362 362
     </example>
363 363
 </section>
364 364
 
365
-<section>
365
+<section id="presence.p.min_expires_action">
366 366
     <title><varname>min_expires_action</varname> (int)</title>
367 367
     <para>
368 368
         The action to take when UA sends a expires value less then min_expires.
... ...
@@ -394,7 +394,7 @@ modparam("presence", "max_expires", 3600)
394 394
     </example>
395 395
 </section>
396 396
 
397
-<section>
397
+<section id="presence.p.server_address">
398 398
 		<title><varname>server_address</varname> (str)</title>
399 399
 		<para>
400 400
 		The presence server address which will become the value of Contact header filed 
... ...
@@ -410,7 +410,7 @@ modparam("presence", "server_address", "sip:10.10.10.10:5060")
410 410
 		</example>
411 411
 	</section>
412 412
 
413
-<section>
413
+<section id="presence.p.subs_db_mode">
414 414
 		<title><varname>subs_db_mode</varname> (int)</title>
415 415
 		<para>
416 416
 		The presence module can utilize database for persistent subscription storage.
... ...
@@ -475,7 +475,7 @@ modparam("presence", "subs_db_mode", 1)
475 475
 		</example>
476 476
 	</section>
477 477
 
478
-	<section>
478
+	<section id="presence.p.publ_cache">
479 479
 		<title><varname>publ_cache</varname> (int)</title>
480 480
 		<para>
481 481
 		To improve performance, the presence module holds by default a
... ...
@@ -505,7 +505,7 @@ modparam("presence", "publ_cache", 0)
505 505
 		</example>
506 506
 	</section>
507 507
 
508
-	<section>
508
+	<section id="presence.p.subs_htable_size">
509 509
 		<title><varname>subs_htable_size</varname> (int)</title>
510 510
 		<para>
511 511
 		The size of the in-memory hash table to store subscription dialogs.
... ...
@@ -525,7 +525,7 @@ modparam("presence", "subs_htable_size", 11)
525 525
 		</example>
526 526
 	</section>
527 527
 
528
-	<section>
528
+	<section id="presence.p.pres_htable_size">
529 529
 		<title><varname>pres_htable_size</varname> (int)</title>
530 530
 		<para>
531 531
         	The size of the in-memory hash table to store publish records.
... ...
@@ -544,7 +544,7 @@ modparam("presence", "pres_htable_size", 11)
544 544
 	</programlisting>
545 545
 		</example>
546 546
 	</section>
547
-	<section>
547
+	<section id="presence.p.send_fast_notify">
548 548
 		<title><varname>send_fast_notify</varname> (int)</title>
549 549
 		<para>
550 550
 		This parameter enables or disables the sending of an initial empty NOTIFY after a SUBSCRIBE/reSUBSCRIBE. 
... ...
@@ -565,7 +565,7 @@ modparam("presence", "send_fast_notify", 0)
565 565
 		</example>
566 566
 	</section>
567 567
 
568
-	<section>
568
+	<section id="presence.p.enable_sphere_check">
569 569
 		<title><varname>enable_sphere_check</varname> (int)</title>
570 570
 		<para>
571 571
 		This parameter is a flag that should be set if permission rules include
... ...
@@ -589,7 +589,7 @@ modparam("presence", "enable_sphere_check", 1)
589 589
 		</example>
590 590
 	</section>
591 591
 
592
-	<section>
592
+	<section id="presence.p.timeout_rm_subs">
593 593
 		<title><varname>timeout_rm_subs</varname> (int)</title>
594 594
 		<para>
595 595
 		This parameter is a flag that should be set if subscriptions should be
... ...
@@ -611,7 +611,7 @@ modparam("presence", "timeout_rm_subs", 0)
611 611
 	</programlisting>
612 612
 		</example>
613 613
 	</section>
614
-	<section>
614
+	<section id="presence.p.fetch_rows">
615 615
 	    <title><varname>fetch_rows</varname> (integer)</title>
616 616
 	    <para>
617 617
 		Number of rows to be loaded in one step from database.
... ...
@@ -630,7 +630,7 @@ modparam("presence", "fetch_rows", 1000)
630 630
 </programlisting>
631 631
 	    </example>
632 632
 	</section>
633
-	<section>
633
+	<section id="presence.p.db_table_lock_type">
634 634
 	    <title><varname>db_table_lock_type</varname> (integer)</title>
635 635
 	    <para>
636 636
 		Enable (=1) or disable (=0) the Locks for table during an
... ...
@@ -703,9 +703,9 @@ modparam("presence", "subs_remove_match", 1)
703 703
 
704 704
 <section>
705 705
 	<title>Functions</title>
706
-	<section>
706
+	<section id="presence.f.handle_publish">
707 707
 		<title>
708
-		<function moreinfo="none">handle_publish(char* sender_uri)</function>
708
+		<function moreinfo="none">handle_publish([sender_uri])</function>
709 709
 		</title>
710 710
 		<para>
711 711
 		Handles PUBLISH requests by storing and updating 
... ...
@@ -760,7 +760,7 @@ modparam("presence", "subs_remove_match", 1)
760 760
 		</example>
761 761
 	</section>
762 762
 
763
-	<section>
763
+	<section id="presence.f.handle_subscribe">
764 764
 		<title>
765 765
 		<function moreinfo="none">handle_subscribe([watcher_uri])</function>
766 766
 		</title>
... ...
@@ -809,7 +809,7 @@ if(method=="SUBSCRIBE")
809 809
 		</example>
810 810
 	</section>
811 811
 
812
-	<section>
812
+	<section id="presence.f.pres_auth_status">
813 813
 		<title>
814 814
 		<function moreinfo="none">pres_auth_status(watcher_uri, presentity_uri)</function>
815 815
 		</title>
... ...
@@ -844,7 +844,7 @@ if (method=="MESSAGE") {
844 844
 		</example>
845 845
 	</section>
846 846
 
847
-	<section>
847
+	<section id="presence.f.pres_refresh_watchers">
848 848
 		<title>
849 849
 		<function moreinfo="none">pres_refresh_watchers(uri, event, type[, file_uri, filename])</function>
850 850
 		</title>
... ...
@@ -904,7 +904,7 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
904 904
 		</example>
905 905
 	</section>
906 906
 
907
-	<section>
907
+	<section id="presence.f.pres_update_whatchers">
908 908
 		<title>
909 909
 		<function moreinfo="none">pres_update_watchers(uri, event)</function>
910 910
 		</title>