$Revision: 1151 $
$Date: 2006-10-06 13:01:07 +0300 (Fri, 06 Oct 2006) $
User's Guide
Overview
gflags module (global flags) keeps a bitmap of flags in shared memory
and may be used to change behaviour of server based on value of the flags.
Example:
if (is_gflag("1")) {
t_relay("udp:10.0.0.1:5060");
} else {
t_relay("udp:10.0.0.2:5060");
}
The benefit of this module is the value of the switch flags
can be manipulated by external applications such as web interface
or command line tools. The size of bitmap is 32.
The module exports external commands that can be used to change
the global flags via Management Interface. The MI commands are:
set_gflag
, reset_gflag
and
is_gflag
.
Dependencies
The module depends on the following modules (in the other words the
listed modules must be loaded before this module):
none
Exported Parameters
<varname>initial</varname> (integer)
The initial value of global flags bitmap.
Default value is 0
.
<varname>initial</varname> parameter usage
modparam("gflags", "initial", 15)
Exported Functions
<function moreinfo="none">set_gflag(flag)</function>
Set the bit at the position flag
in global flags.
flag
can have a value from the range 1..31.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
<function moreinfo="none">set_gflag()</function> usage
...
set_gflag("4");
...
<function moreinfo="none">reset_gflag(flag)</function>
Reset the bit at the position flag
in global flags.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
<function moreinfo="none">reset_gflag()</function> usage
...
reset_gflag("4");
...
<function moreinfo="none">is_gflag(flag)</function>
Check if bit at the position flag
in global flags is
set.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
<function moreinfo="none">is_gflag()</function> usage
...
if(is_gflag("4"))
{
log("global flag 4 is set\n");
} else {
log("global flag 4 is not set\n");
};
...
<acronym>MI</acronym> Commands
<function moreinfo="none">set_gflag</function>
Set the value of some flags to 1. The function accepts one
parameter which is the flag bitmap/mask specifing the flags to be
set.
The paremeter value must be a number in decimal or hexa format
<function moreinfo="none">set_gflag</function> usage
...
$ openserctl fifo set_gflag 1
$ openserctl fifo set_gflag 0x3
...
<function moreinfo="none">reset_gflag</function>
Reset the value of some flags to 0. The function accepts one
parameter which is the flag bitmap/mask specifing the flags to be
reset.
The paremeter value must be a number in decimal or hexa format
<function moreinfo="none">reset_gflag</function> usage
...
$ openserctl fifo reset_gflag 1
$ openserctl fifo reset_gflag 0x3
...
<function moreinfo="none">is_gflag</function>
Return the status of a set of flags. The function accepts one
parameter which is the flag bitmap/mask specifing the flags to be
checked.
The function returns TRUE if all the flags from the set are set
and FALSE if at least one is not set.
<function moreinfo="none">set_gflag</function> usage
...
$ openserctl fifo is_gflag 1
$ openserctl fifo is_gflag 0x3
...
<function moreinfo="none">get_gflags</function>
Return the bitmap with all flags. The function gets no
parameters and returns the bitmap in hexa and decimal format.
<function moreinfo="none">get_gflags</function> usage
...
$ openserctl fifo get_gflags
0x3039
12345
...