Skip to content

Commit 526b538

Browse files
committed
nathelper: Improve docs on fix_nated_register() and received_avp
1 parent a1b2738 commit 526b538

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

modules/nathelper/doc/nathelper_admin.xml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -218,17 +218,19 @@ modparam("nathelper", "natping_socket", "192.168.1.1:5006")
218218
<title><varname>received_avp</varname> (str)</title>
219219
<para>
220220
The name of the Attribute-Value-Pair (AVP) used to store the URI
221-
containing the received IP, port, and protocol. The URI is created
222-
by fix_nated_register function of nathelper module and the attribute
223-
is then used by the registrar to store the received parameters. Do
224-
not forget to change the value of corresponding parameter in
225-
registrar module if you change the value of this parameter.
221+
containing the received IP, port and protocol. The URI is created
222+
by the <xref linkend="func_fix_nated_register"/> function and this data
223+
may then be also picked up by the registrar module, which will attach a
224+
"Received=" attribute to the registration. Do not forget to change the
225+
value of corresponding parameter in the <ulink url='registrar'>registrar</ulink>
226+
module whenever you change the value of this parameter.
226227
</para>
227228
<note>
228229
<para>
229-
You must set this parameter if you use "fix_nated_register". In such
230-
case you must set the parameter with same name of "registrar"
231-
module to same value.
230+
You must set this parameter if you use <xref linkend="func_fix_nated_register"/>.
231+
Additionally, if you are using registrar, you must also set its symmetric
232+
<ulink url='registrar#received_avp'>received_avp</ulink> module parameter
233+
to the <emphasis role='bold'>same value</emphasis>.
232234
</para>
233235
</note>
234236
<para>
@@ -750,10 +752,11 @@ add_rcv_param(1); # add the parameter to the Contact URI
750752
<function moreinfo="none">fix_nated_register()</function>
751753
</title>
752754
<para>
753-
The function creates a URI consisting of the source IP, port, and
754-
protocol and stores the URI in an Attribute-Value-Pair. The URI will
755+
The function creates a URI consisting of the source IP, port and
756+
protocol and stores it in the <xref linkend="param_received_avp"/> AVP. The URI will
755757
be appended as "received" parameter to Contact in 200 OK and
756-
registrar will store it in the user location database.
758+
may also be stored in the user location database if the same AVP
759+
is also configured for the <ulink url='registrar'>registrar</ulink> module.
757760
</para>
758761
<para>
759762
This function can be used from REQUEST_ROUTE.

0 commit comments

Comments
 (0)