-
Notifications
You must be signed in to change notification settings - Fork 909
/
pua_bla_admin.xml
195 lines (182 loc) · 4.55 KB
/
pua_bla_admin.xml
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
<?xml version="1.0" encoding='ISO-8859-1'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!-- Include general documentation entities -->
<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
%docentities;
]>
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section>
<title>Overview</title>
<para>
The pua_bla module enables Bridged Line Appearances support according to
the specifications in draft-anil-sipping-bla-03.txt.
</para>
</section>
<section>
<title>Dependencies</title>
<section>
<title>&kamailio; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>usrloc</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis>pua</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis>presence</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before running
&kamailio; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>libxml</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section>
<title><varname>default_domain</varname>(str)</title>
<para>
The default domain for the registered users to be used when
constructing the uri for the registrar callback.
</para>
<para>
<emphasis> Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>default_domain</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_bla", "default_domain", "kamailio.org")
...
</programlisting>
</example>
</section>
<section>
<title><varname>header_name</varname>(str)</title>
<para>
The name of the header to be added to Publish requests.
It will contain the uri of the user agent that sent the
Notify that is transformed into Publish. It stops sending
a Notification with the same information to the sender.
</para>
<para>
<emphasis> Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>header_name</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_bla", "header_name", "Sender")
...
</programlisting>
</example>
</section>
<section>
<title><varname>outbound_proxy</varname>(str)</title>
<para>
The outbound_proxy uri to be used when sending Subscribe requests.
</para>
<para>
<emphasis> Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>outbound_proxy</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_bla", "outbound_proxy", "sip:proxy@kamailio.org")
...
</programlisting>
</example>
</section>
<section>
<title><varname>server_address</varname>(str)</title>
<para>
The IP address of the server.
</para>
<example>
<title>Set <varname>server_address</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_bla", "server_address", "sip:bla@160.34.23.12")
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Functions</title>
<section>
<title>
<function moreinfo="none">bla_set_flag</function>
</title>
<para>
The function is used to mark REGISTER requests made to a BLA AOR.
The module subscribes to the registered contacts for dialog;sla
event.
</para>
<para>
</para>
<example>
<title><function>bla_set_flag</function> usage</title>
<programlisting format="linespecific">
...
if(is_method("REGISTER") && to_uri=~"bla_aor@kamailio.org")
bla_set_flag();
...
</programlisting>
</example>
</section>
<section>
<title>
<function moreinfo="none">bla_handle_notify</function>
</title>
<para>
The function handles Notify requests sent from phones on the
same BLA to the server. The message is transformed in Publish
request and passed to presence module for further handling.
in case of a successful processing a 2xx reply should be sent.
</para>
<para>
</para>
<example>
<title><function>bla_handle_notify</function> usage</title>
<programlisting format="linespecific">
...
if(is_method("NOTIFY") && to_uri=~"bla_aor@kamailio.org")
{
if( bla_handle_notify() )
t_reply("200", "OK");
}
...
</programlisting>
</example>
</section>
</section>
</chapter>