1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!-- Auth_radius Module User's Guide -->
<chapter>
<chapterinfo>
<revhistory>
<revision>
<revnumber>$Revision: 1.6 $</revnumber>
<date>$Date: 2006/06/07 10:45:32 $</date>
</revision>
</revhistory>
</chapterinfo>
<title>User's Guide</title>
<section>
<title>Overview</title>
<para>
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.
E.g., if (is_gflag("1")) { t_relay_to_udp("10.0.0.1","5060"); }
else { t_relay_to_udp("10.0.0.2","5060"); }.
</para>
<para>
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 or 64 on
64bit architectures.
</para>
<para>
The module exports commands to FIFO server that can be used to change
the global flags via FIFO interface. The FIFO commands are:
<quote>set_gflag</quote>, <quote>reset_gflag</quote> and
<quote>is_gflag</quote>.
</para>
</section>
<section>
<title>Dependencies</title>
<para>
The module depends on the following modules (in the other words the
listed modules must be loaded before this module):
<itemizedlist>
<listitem>
<para><emphasis>none</emphasis></para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>Exported Parameters</title>
<section>
<title><varname>initial</varname> (integer)</title>
<para>
The initial value of global flags bitmap.
</para>
<para>
Default value is <quote>0</quote>.
</para>
<example>
<title><varname>initial</varname> parameter usage</title>
<programlisting format="linespecific">
modparam("gflags", "initial", 15)
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Functions</title>
<section>
<title><function moreinfo="none">set_gflag(flag)</function></title>
<para>
Set the bit at the position <quote>flag</quote> in global flags.
</para>
<para>
<quote>flag</quote> can have a value from the range 1..31.
</para>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
</para>
<example>
<title><function moreinfo="none">set_gflag()</function> usage</title>
<programlisting format="linespecific">
...
set_gflag("4");
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">reset_gflag(flag)</function></title>
<para>
Reset the bit at the position <quote>flag</quote> in global flags.
</para>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
</para>
<example>
<title><function moreinfo="none">reset_gflag()</function> usage</title>
<programlisting format="linespecific">
...
reset_gflag("4");
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">is_gflag(flag)</function></title>
<para>
Check if bit at the position <quote>flag</quote> in global flags is
set.
</para>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.
</para>
<example>
<title><function moreinfo="none">is_gflag()</function> usage</title>
<programlisting format="linespecific">
...
if(is_gflag("4"))
{
log("global flag 4 is set\n");
} else {
log("global flag 4 is not set\n");
};
...
</programlisting>
</example>
</section>
</section>
<section>
<title><acronym>FIFO</acronym> Commands</title>
<section>
<title><function moreinfo="none">set_gflag</function></title>
<para>
Set the value of a flag to 1. The function accepts one
parameter which is the number of the flag to be set.
</para>
<example>
<title><function moreinfo="none">set_gflag</function> usage</title>
<programlisting format="linespecific">
...
$ openserctl fifo set_gflag 1
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">reset_gflag</function></title>
<para>
Reset the value of a flag to 0. The function accepts
one parameter which is the number of the flag to be reset.
</para>
<example>
<title>
<function moreinfo="none">reset_gflag</function> usage</title>
<programlisting format="linespecific">
...
$ openserctl fifo reset_gflag 1
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">is_gflag</function></title>
<para>
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.
</para>
<example>
<title><function moreinfo="none">set_gflag</function> usage</title>
<programlisting format="linespecific">
...
$ openserctl fifo is_gflag 1
...
</programlisting>
</example>
</section>
<section>
<title><function moreinfo="none">get_gflags</function></title>
<para>
Return the bitmap with all flags. The FIFO function gets no
parameters and returns the bitmap in hexa format on the first line
and decimal format on the second line.
</para>
<example>
<title>
<function moreinfo="none">get_gflags</function> usage</title>
<programlisting format="linespecific">
...
$ openserctl fifo get_gflags
0x3039
12345
...
</programlisting>
</example>
</section>
</section>
</chapter>
<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("gflags.sgml" "Book" "chapter")
End:
-->
|
