Skip to content

Commit

Permalink
pua_dialoginfo: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
@miconda
miconda committed Nov 13, 2023
1 parent 8bacf4e commit e7169ec
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
6 changes: 3 additions & 3 deletions src/modules/pua_dialoginfo/doc/pua_dialoginfo.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include href="pua_dialoginfo_admin.xml"/>


</book>


66 changes: 33 additions & 33 deletions src/modules/pua_dialoginfo/doc/pua_dialoginfo_admin.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@
<!-- Module User's Guide -->

<chapter>

<title>&adminguide;</title>

<section>
<title>Overview</title>
<para>
The pua_dialoginfo retrieves dialog state information from the
The pua_dialoginfo retrieves dialog state information from the
dialog module and PUBLISHes the dialog-information using the pua
module. Thus, in combination with the presence_xml module this can
be used to derive dialog-info from the dialog module and NOTIFY
the subscribed watchers about dialog-info changes. This can be used
for example with SNOM and Linksys phones.
</para>
<para>
Note: This implements dialog-info according to RFC 4235 and is not
Note: This implements dialog-info according to RFC 4235 and is not
compatible with the BLA feature defined in draft-anil-sipping-bla-03.txt.
(Actually the BLA draft is really crap as it changes SIP semantics)
</para>
Expand All @@ -44,9 +44,9 @@
version="1"
state="full"
entity="sip:alice@example.com">
<dialog id="as7d900as8"
<dialog id="as7d900as8"
call-id="a84b4c76e66710"
local-tag="1928301774"
local-tag="1928301774"
remote-tag="456887766"
direction="initiator">
<state>early</state>
Expand All @@ -55,7 +55,7 @@
]]>
</programlisting>

The root element is the "dialog-info". It contains the namespace, the
The root element is the "dialog-info". It contains the namespace, the
version (which must be incremented for each new PUBLISH for this certain
dialog), the state (this module only supports state=full) and the entity
for which we publish the dialog-info.
Expand All @@ -64,10 +64,10 @@
<para>

The "dialog" element must contain an id parameter. The id parameter is
usually different to the optional call-id parameter (which is the call-id of the
usually different to the optional call-id parameter (which is the call-id of the
INVITE request) as an INVITE can create multiple dialogs (forked request). But
as the dialog module does not support multiple dialogs created by a single
transaction, the pua_dialoginfo module sets the id parameter to the same
as the dialog module does not support multiple dialogs created by a single
transaction, the pua_dialoginfo module sets the id parameter to the same
value as the call-id parameter. The "local-tag" indicates the local tag of the
entity. The remote-tag indicates the tag of the remote party. The "direction"
indicates if the entity was the initiator of the dialog or the recipient (aka
Expand All @@ -90,9 +90,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<dialog-info xmlns="urn:ietf:params:xml:ns:dialog-info"
version="1" state="full">
<dialog id="as7d900as8"
<dialog id="as7d900as8"
call-id="a84b4c76e66710"
local-tag="1928301774"
local-tag="1928301774"
remote-tag="456887766"
direction="initiator">
<state>early</state>
Expand All @@ -109,18 +109,18 @@
]]>
</programlisting>

The local and remote elements are needed to implement call pickup. For example if
The local and remote elements are needed to implement call pickup. For example if
the above XML document is received by somebody who SUBSCRIBEd the dialog-info of
Alice, then it can pick-up the call by sending an INVITE to Bob (actually I am not
sure if it should use the URI in the identity element or the URI in the target
sure if it should use the URI in the identity element or the URI in the target
parameter) which contains a Replaces header which contains the call-id and the tags.
This was tested successfully with Linksys SPA962 phones and with SNOM 320 Firmware 7.3.7
(you have to set the function key to "Extension").

</para>
<para>

A dialog-info XML document may contain multiple "dialog" elements, for
A dialog-info XML document may contain multiple "dialog" elements, for
example if the entity has multiple ongoing dialogs. For example the
following XML document shows a confirmed dialog and an early (probably
a second incoming call) dialog.
Expand Down Expand Up @@ -155,8 +155,8 @@

</para>
<para>
If there are problems with the callbacks from dialog module and you want to

If there are problems with the callbacks from dialog module and you want to
debug them you define PUA_DIALOGINFO_DEBUG in pua_dialoginfo.c and recompile.
</para>
</section>
Expand All @@ -177,12 +177,12 @@
The module tries to find out if the entity is a local user. Only PUBLISH to
local user are sent. Therefore, the module needs to find out if the domain is
a local one or not. It uses the same mechanism as the "==myself" mechanism. Thus,
all domains have to be declared with the "alias=..." option in &kamailio;.cfg.
all domains have to be declared with the "alias=..." option in &kamailio;.cfg.
DB-based multidomain support as offered by "domain" module is not supported yet.
Conclusion: The module has the same "domain" problems as the "rr" module.
</para></listitem>
<listitem><para>
The module puts the call-id of the dialog into an XML parameter. Thus, if the
The module puts the call-id of the dialog into an XML parameter. Thus, if the
call-id contains quotes, they should be escaped. This is not yet implemented. Thus,
if the call-id contains quotes the XML document will be invalid.
</para></listitem>
Expand Down Expand Up @@ -275,7 +275,7 @@ modparam("pua_dialoginfo", "include_tags", 0)
<title><varname>include_localremote</varname> (int)</title>
<para>
If this parameter is set, the optional local and remote elements
will be put into the dialog element. This is needed for call-pickup
will be put into the dialog element. This is needed for call-pickup
features.
</para>
<para>
Expand All @@ -298,7 +298,7 @@ modparam("pua_dialoginfo", "include_localremote", 0)
The value of the expires is usually taken from the lifetime of the dialog
(see README of dialog module). If the override_lifetime is set, the value
specified here is used instead of the lifetime of the dialog module.
If used, the value should at least be a few seconds more than the
If used, the value should at least be a few seconds more than the
fr_inv_timer of the tm module.
</para>
<para>
Expand Down Expand Up @@ -336,8 +336,8 @@ modparam("pua_dialoginfo", "include_req_uri", 1)
<section>
<title><varname>caller_confirmed</varname> (int)</title>
<para>
Usually the dialog-info of the caller will be
"trying -> early -> confirmed" and the dialog-info of the callee
Usually the dialog-info of the caller will be
"trying -> early -> confirmed" and the dialog-info of the callee
will be "early -> confirmed". On some phones the function LED
will start blinking if the state is early, regardless if is is the
caller or the callee (indicated with the "direction" parameter).
Expand All @@ -358,7 +358,7 @@ modparam("pua_dialoginfo", "caller_confirmed", 1)
</programlisting>
</example>
</section>

<section>
<title><varname>send_publish_flag</varname> (int)</title>
<para>
Expand Down Expand Up @@ -415,11 +415,11 @@ modparam("pua_dialoginfo", "disable_callee_publish_flag", 10)
</programlisting>
</example>
</section>

<section>
<title><varname>use_pubruri_avps</varname> (int)</title>
<para>
Get Publish R-Uri from avps (see corresponding avp params), not from request to/from uri.
Get Publish R-Uri from avps (see corresponding avp params), not from request to/from uri.
</para>
<para>
<emphasis>Default value is <quote>0</quote>.</emphasis>
Expand Down Expand Up @@ -455,9 +455,9 @@ modparam("pua_dialoginfo", "refresh_pubruri_avps_flag", 11)
<section>
<title><varname>pubruri_caller_avp</varname> (str)</title>
<para>
If use_pubruri_avps is enabled, PUBLISH-requests reporting dialog-information about the caller (entity=caller) are sent using the value of the specified avp as R-Uri.
If use_pubruri_avps is enabled, PUBLISH-requests reporting dialog-information about the caller (entity=caller) are sent using the value of the specified avp as R-Uri.
If multiple AVPs with the same name (but different indexes) are present, for each value a corresponding PUBLISH-request is generated.
If no AVP with the specified name exists, no caller-related PUBLISH requests are sent.
If no AVP with the specified name exists, no caller-related PUBLISH requests are sent.
</para>
<para>
<emphasis>Default value is <quote>NULL</quote>.</emphasis>
Expand All @@ -471,13 +471,13 @@ modparam("pua_dialoginfo", "pubruri_caller_avp", "$avp(s:puburis_caller)")
</programlisting>
</example>
</section>

<section>
<title><varname>pubruri_callee_avp</varname> (str)</title>
<para>
If use_pubruri_avps is enabled, PUBLISH-requests reporting dialog-information about the callee (entity=callee) are sent using the value of the specified avp as R-Uri.
If use_pubruri_avps is enabled, PUBLISH-requests reporting dialog-information about the callee (entity=callee) are sent using the value of the specified avp as R-Uri.
If multiple AVPs with the same name (but different indexes) are present, for each value a corresponding PUBLISH-request is generated.
If no AVP with the specified name exists, no callee-related PUBLISH requests are sent.
If no AVP with the specified name exists, no callee-related PUBLISH requests are sent.
</para>
<para>
<emphasis>Default value is <quote>NULL</quote>.</emphasis>
Expand Down Expand Up @@ -513,7 +513,7 @@ modparam("pua_dialoginfo", "pubruri_caller_dlg_var", "pubruri_caller")
</programlisting>
</example>
</section>

<section id="pua_dialoginfo.p.pubruri_callee_dlg_var">
<title><varname>pubruri_callee_dlg_var</varname> (str)</title>
<para>
Expand Down Expand Up @@ -662,7 +662,7 @@ modparam("pua_dialoginfo", "attribute_display", 1)

<section>
<title>Functions</title>
</section>
</section>

</chapter>

0 comments on commit e7169ec

Please sign in to comment.