From 6429161f85cd34190a6d2b7dcda3775e0e2d5406 Mon Sep 17 00:00:00 2001 From: "Olle E. Johansson" Date: Sat, 17 Jan 2015 11:03:49 +0100 Subject: [PATCH] uid_gflags Update README (SER => Kamailio) --- modules/uid_gflags/README | 76 +++++++++++++-------------- modules/uid_gflags/doc/fifo.xml | 12 +++-- modules/uid_gflags/doc/functions.xml | 10 +++- modules/uid_gflags/doc/params.xml | 12 +++-- modules/uid_gflags/doc/uid_gflags.xml | 16 ++++-- modules/uid_gflags/doc/xmlrpc.xml | 16 ++++-- 6 files changed, 85 insertions(+), 57 deletions(-) diff --git a/modules/uid_gflags/README b/modules/uid_gflags/README index 4997b422100..4679fb7bf41 100644 --- a/modules/uid_gflags/README +++ b/modules/uid_gflags/README @@ -1,4 +1,3 @@ - UID Gflags Module Jiri Kuthan @@ -6,7 +5,7 @@ Jiri Kuthan Copyright © 2004 FhG FOKUS - _________________________________________________________________ + __________________________________________________________________ Table of Contents @@ -24,7 +23,7 @@ Jiri Kuthan 3.3. is_ugflag(flag_num) 4. FIFO Interface - 5. XMLRPC Interface + 5. RPC Interface List of Examples @@ -47,18 +46,18 @@ Chapter 1. Admin Guide 3.3. is_ugflag(flag_num) 4. FIFO Interface - 5. XMLRPC Interface + 5. RPC Interface 1. Overview - The module implements global flags. The difference between the global - flags and flags that can be used in the configuration file or AVPs is - that they the scope of the global flags is not limited to the SIP - message or transaction being processed. Global flags are always + The module implements global flags. The difference between the global + flags and flags that can be used in the configuration file or AVPs is + that they the scope of the global flags is not limited to the SIP + message or transaction being processed. Global flags are always available, their contents is not forgotten when a SIP transaction gets - destroyed in SER. + destroyed in Kamailio. - Global flags can be accessed from the configuration script, for + Global flags can be accessed from the configuration script, for example: if (is_ugflag("1")) { t_relay_to_udp("10.0.0.1", "5060"); @@ -66,10 +65,10 @@ if (is_ugflag("1")) { t_relay_to_udp("10.0.0.2", "5060"); }; - The value of the global flags can be manipulated by external tools - such as the web interface of SER or cmd line administration tools. One - particular application of global flags could be runtime configuration - changes without the need to restart SER. + The value of the global flags can be manipulated by external tools such + as the web interface of Kamailio or cmd line administration tools. One + particular application of global flags could be runtime configuration + changes without the need to restart Kamailio. 2. Parameters @@ -77,7 +76,7 @@ if (is_ugflag("1")) { 2.1. initial (integer) - The initial value of global flags. Each bit in the integer represents + The initial value of global flags. Each bit in the integer represents one flag. Default value is 0. @@ -90,8 +89,8 @@ if (is_ugflag("1")) { 3.1. set_gflag(flag_num) - Set the flag identified by flag_num to 1. The range of flag_num is 0 - to 31. + Set the flag identified by flag_num to 1. The range of flag_num is 0 to + 31. Example 1.1. set_ugflag usage ... @@ -100,8 +99,8 @@ set_ugflag("2"); 3.2. reset_ugflag(flag_num) - Set the flag identified by flag_num to 0. The range of flag_num is 0 - to 31. + Set the flag identified by flag_num to 0. The range of flag_num is 0 to + 31. Example 1.2. reset_ugflag usage ... @@ -110,38 +109,37 @@ reset_ugflag("2"); 3.3. is_ugflag(flag_num) - Returns 1 when flag identified by flag_num is set, 0 otherwise. The + Returns 1 when flag identified by flag_num is set, 0 otherwise. The range of flag_num parameter is 0 to 31. 4. FIFO Interface - The state of the global flags can be read and modified over the FIFO - interface of SER. This module implements the following FIFO interface - functions: + The state of the global flags can be read and modified over the FIFO + interface of Kamailio. This module implements the following FIFO + interface functions: * set_gflag - Set the value of a flag to 1. The function accepts one parameter which is the number of the flag to be set. * reset_gflag - Reset the value of a flag to 0. The function accepts one parameter which is the number of the flag to be reset. - * is_gflag - Return the status of a flag. The FIFO function would - return TRUE if the flag is set and FALSE if it is not set. The - only parameter of this function is the number of the flag. - -5. XMLRPC Interface - - The state of the global flags can be read and modified over the XMLRPC - interface. This module implements the following XMLRPC interface - commands: - * gflags.set - Set the value of a flag to 1. The function accepts - one parameter which is the number of the flag to be set. - * gflags.reset - Reset the value of a flag to 0. The function - accepts one parameter which is the number of the flag to be reset. - * gflags.is_set - Return the status of a flag. The FIFO function - would return TRUE if the flag is set and FALSE if it is not set. + * is_gflag - Return the status of a flag. The FIFO function would + return TRUE if the flag is set and FALSE if it is not set. The only + parameter of this function is the number of the flag. + +5. RPC Interface + + The state of the global flags can be read and modified over the RPC + interface. This module implements the following RPC interface commands: + * gflags.set - Set the value of a flag to 1. The function accepts one + parameter which is the number of the flag to be set. + * gflags.reset - Reset the value of a flag to 0. The function accepts + one parameter which is the number of the flag to be reset. + * gflags.is_set - Return the status of a flag. The FIFO function + would return TRUE if the flag is set and FALSE if it is not set. The only parameter of this function is the number of the flag. * gflags.flush - Flush the state of global flags into database. * gflags.dump - Return the status of all flags. The value is TRUE if the flag is set and FALSE if the flag is not set. The function has no parameters. - * global.reload - Reload values from global_attrs DB table. This + * global.reload - Reload values from global_attrs DB table. This function does not have any parameters. There is no return value on success. diff --git a/modules/uid_gflags/doc/fifo.xml b/modules/uid_gflags/doc/fifo.xml index 2116699bfaa..18d9b9b0e0c 100644 --- a/modules/uid_gflags/doc/fifo.xml +++ b/modules/uid_gflags/doc/fifo.xml @@ -1,6 +1,12 @@ - + + +%docentities; + +]>
@@ -10,7 +16,7 @@ The state of the global flags can be read and modified over the FIFO - interface of SER. This module implements the following FIFO interface + interface of &kamailio;. This module implements the following FIFO interface functions: diff --git a/modules/uid_gflags/doc/functions.xml b/modules/uid_gflags/doc/functions.xml index 912ea4cfc93..1833fadfc98 100644 --- a/modules/uid_gflags/doc/functions.xml +++ b/modules/uid_gflags/doc/functions.xml @@ -1,6 +1,12 @@ - + + +%docentities; + +]>
diff --git a/modules/uid_gflags/doc/params.xml b/modules/uid_gflags/doc/params.xml index 95bdb460584..ccf651d2edb 100644 --- a/modules/uid_gflags/doc/params.xml +++ b/modules/uid_gflags/doc/params.xml @@ -1,6 +1,12 @@ - + + +%docentities; + +]>
@@ -8,7 +14,7 @@ Parameters -
+
<varname>initial</varname> (integer) The initial value of global flags. Each bit in the integer diff --git a/modules/uid_gflags/doc/uid_gflags.xml b/modules/uid_gflags/doc/uid_gflags.xml index 0925619a83b..5365e3933d5 100644 --- a/modules/uid_gflags/doc/uid_gflags.xml +++ b/modules/uid_gflags/doc/uid_gflags.xml @@ -1,6 +1,12 @@ - + + +%docentities; + +]> @@ -29,7 +35,7 @@ or AVPs is that they the scope of the global flags is not limited to the SIP message or transaction being processed. Global flags are always available, their contents is not forgotten when a SIP - transaction gets destroyed in SER. + transaction gets destroyed in &kamailio;. Global flags can be accessed from the configuration script, for example: @@ -43,9 +49,9 @@ if (is_ugflag("1")) { The value of the global flags can be manipulated by external tools - such as the web interface of SER or cmd line administration + such as the web interface of &kamailio; or cmd line administration tools. One particular application of global flags could be runtime - configuration changes without the need to restart SER. + configuration changes without the need to restart &kamailio;.
diff --git a/modules/uid_gflags/doc/xmlrpc.xml b/modules/uid_gflags/doc/xmlrpc.xml index 8d78b91b6dd..3bd9bc6fefe 100644 --- a/modules/uid_gflags/doc/xmlrpc.xml +++ b/modules/uid_gflags/doc/xmlrpc.xml @@ -1,16 +1,22 @@ - + + +%docentities; + +]>
- XMLRPC Interface + RPC Interface - The state of the global flags can be read and modified over the XMLRPC - interface. This module implements the following XMLRPC interface commands: + The state of the global flags can be read and modified over the RPC + interface. This module implements the following RPC interface commands: