Browse code

- added docs (copy-paste from mailing list)

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@2377 689a6050-402a-0410-94f2-e92a70836424

Klaus Darilion authored on 25/06/2007 06:36:46
Showing 2 changed files
... ...
@@ -413,6 +413,12 @@ append_to_reply("Foo: $rm at $Ts\r\n");
413 413
      * txt - Header field to be appended. The value can contain
414 414
        pseudo-variables which will be replaced at run time.
415 415
 
416
+   Note: Headers which are added in main route cannot be removed
417
+   in further routes (e.g. failure routes). So, the idea is not
418
+   to add there any headers that you might want to remove later.
419
+   To add headers temporarely use the branch route because the
420
+   changes you do there are per-branch.
421
+
416 422
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
417 423
    FAILURE_ROUTE, BRANCH_ROUTE.
418 424
 
... ...
@@ -540,6 +540,12 @@ append_to_reply("Foo: $rm at $Ts\r\n");
540 540
 		</listitem>
541 541
 		</itemizedlist>
542 542
 		<para>
543
+		Note: Headers which are added in main route cannot be removed in further routes
544
+		(e.g. failure routes). So, the idea is not to add there any headers that you 
545
+		might want to remove later. To add headers temporarely use the branch route 
546
+		because the changes you do there are per-branch.
547
+		</para>
548
+		<para>
543 549
 		This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, 
544 550
 		FAILURE_ROUTE, BRANCH_ROUTE.
545 551
 		</para>