[sr-dev] git:master: textopsx: documented return behavior of msg_apply_changes()

Module: sip-router Branch: master Commit: 1257d6832381d50280dff9133f0d5da7c4a58231 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=1257d68… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Aug 15 16:14:34 2014 +0200 textopsx: documented return behavior of msg_apply_changes() --- modules/textopsx/README | 7 +++++++ modules/textopsx/doc/functions.xml | 8 ++++++++ 2 files changed, 15 insertions(+), 0 deletions(-) diff --git a/modules/textopsx/README b/modules/textopsx/README index d53e2eb..3ff68fe 100644 --- a/modules/textopsx/README +++ b/modules/textopsx/README @@ -119,6 +119,13 @@ Chapter 1. Admin Guide the SIP message buffer so far, using this function might change the behaviour of your config. Do test your config properly! + The function returns true (1) on success. If it is failure before the + new content is build, the function returns false (-1), the old content + is still in place. If parsing of the new content is failing, the + function stops executions of the config file (the internal structure is + no longer valid for config processing, like it happens when a broken + message is received from network). + This function can be used from REQUEST_ROUTE or ONREPLY_ROUTE. Example 1.1. msg_apply_changes() usage diff --git a/modules/textopsx/doc/functions.xml b/modules/textopsx/doc/functions.xml index 57d6d31..53fd113 100644 --- a/modules/textopsx/doc/functions.xml +++ b/modules/textopsx/doc/functions.xml @@ -16,6 +16,14 @@ the behaviour of your config. Do test your config properly! </para> <para> + The function returns true (1) on success. If it is failure before the + new content is build, the function returns false (-1), the old content + is still in place. If parsing of the new content is failing, the + function stops executions of the config file (the internal structure + is no longer valid for config processing, like it happens when a + broken message is received from network). + </para> + <para> This function can be used from REQUEST_ROUTE or ONREPLY_ROUTE. </para> <example>