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
|
uri Module
Jan Janak
FhG FOKUS
Edited by
Jan Janak
Bogdan-Andrei Iancu
Copyright 2003 FhG FOKUS
Copyright 2005 voice-system.ro
_________________________________________________________
Table of Contents
1. User's Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSER Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.4. Exported Functions
1.4.1. is_user(username)
1.4.2. has_totag()
1.4.3. uri_param(param)
1.4.4. uri_param(param,value)
1.4.5. add_uri_param(param)
1.4.6. tel2sip()
2. Developer's Guide
3. Frequently Asked Questions
List of Examples
1-1. is_user usage
1-2. has_totag usage
1-3. uri_param usage
1-4. uri_param usage
1-5. add_uri_param usage
1-6. tel2sip usage
_________________________________________________________
Chapter 1. User's Guide
1.1. Overview
Various checks related to SIP URI.
_________________________________________________________
1.2. Dependencies
1.2.1. OpenSER Modules
None.
_________________________________________________________
1.2.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSER with this module loaded:
* None.
_________________________________________________________
1.3. Exported Parameters
None.
_________________________________________________________
1.4. Exported Functions
1.4.1. is_user(username)
Check if the username in credentials matches the given
username.
Meaning of the parameters is as follows:
* username - Username string.
This function can be used from REQUEST_ROUTE.
Example 1-1. is_user usage
...
if (is_user("john")) {
...
};
...
_________________________________________________________
1.4.2. has_totag()
Check if To header field uri contains tag parameter.
This function can be used from REQUEST_ROUTE.
Example 1-2. has_totag usage
...
if (has_totag()) {
...
};
...
_________________________________________________________
1.4.3. uri_param(param)
Find if Request URI has a given parameter with no value
Meaning of the parameters is as follows:
* param - parameter name to look for.
This function can be used from REQUEST_ROUTE.
Example 1-3. uri_param usage
...
if (uri_param("param1")) {
...
};
...
_________________________________________________________
1.4.4. uri_param(param,value)
Find if Request URI has a given parameter with matching value
Meaning of the parameters is as follows:
* param - parameter name to look for.
* value - parameter value to match.
This function can be used from REQUEST_ROUTE.
Example 1-4. uri_param usage
...
if (uri_param("param1","value1")) {
...
};
...
_________________________________________________________
1.4.5. add_uri_param(param)
Add to RURI a parameter (name=value);
Meaning of the parameters is as follows:
* param - parameter to be appended in "name=value" format.
This function can be used from REQUEST_ROUTE.
Example 1-5. add_uri_param usage
...
add_uri_param("nat=yes");
...
_________________________________________________________
1.4.6. tel2sip()
Converts RURI, if it is tel URI, to SIP URI. Returns true,
only if conversion succeeded or if no conversion was needed
(like RURI was not tel URI.
This function can be used from REQUEST_ROUTE.
Example 1-6. tel2sip usage
...
tel2sip();
...
_________________________________________________________
Chapter 2. Developer's Guide
The module does not provide any API to use in other OpenSER
modules.
_________________________________________________________
Chapter 3. Frequently Asked Questions
3.1. Where can I find more about OpenSER?
3.2. Where can I post a question about this module?
3.3. How can I report a bug?
3.1. Where can I find more about OpenSER?
Take a look at http://openser.org/.
3.2. Where can I post a question about this module?
First at all check if your question was already answered on
one of our mailing lists:
* User Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/users
* Developer Mailing List -
http://openser.org/cgi-bin/mailman/listinfo/devel
E-mails regarding any stable OpenSER release should be sent to
<users@openser.org> and e-mails regarding development versions
should be sent to <devel@openser.org>.
If you want to keep the mail private, send it to
<team@openser.org>.
3.3. How can I report a bug?
Please follow the guidelines provided at:
http://sourceforge.net/tracker/?group_id=139143.
|
