[sr-dev] git:master: tmx: documentation updated
Daniel-Constantin Mierla
miconda at gmail.com
Tue May 11 16:19:25 CEST 2010
Hello Klaus,
On 5/11/10 4:09 PM, Klaus Darilion wrote:
> Hi Daniel!
>
> Intersting new features.
thanks, type fixed!
>
> 1. There is a typo
>
> Am 11.05.2010 15:27, schrieb Daniel-Constantin Mierla:
>> +3.3. t_reply_callid(callid, cseq, code, reason)
>> +
>> + Send reply to first INVITE transaction identified by callid and
>> cseq.
>> +
>> + Parameters:.
>> + * callid - call-id value.
>> + * cseq - cseq number.
>> + * code - reply code.
>> + * reason - reply reason.
>> +
>> + This function can be used in ANY_ROUTE.
>> +
>> + Example 1.3. t_cancel_reply usage
>> +...
>> +if (t_cancel_callid("123qaz", "5", "458", "Replied remotely")) {
> ^^^^^^^^^^^^^^
> should be t_reply_callid().
>
>
> 2. Can it be used to send final failure replies only (>300) or also
> 2xx and 1xx?
should be ok for any reply, I don't see any issue right now, just you
need other tricks for setting the body if you need.
>
> 3. What exactly is the "flag" in t_cancel_callid? transaction flag?
> branch flag? So calling t_cancel_callid("123qaz", "5", "22") is
> equivalent to calling setflag(22) in the respective INVITE transaction?
>
It is transaction flag, like setflag(22) for INVITE.
Cheers,
Daniel
> regards
> klaus
>
>
>
>> + xlog("transaction replied\n");
>> +}
>> +...
>> +
>> 4. Exported pseudo-variables
>>
>> * $T_branch_idx
>> @@ -153,22 +199,22 @@ if (t_cancel_branches("all")) {
>> 5.3. t_hash
>> 5.4. t_reply
>>
>> -5.1. t_uac_dlg
>> +5.1. t_uac_dlg
>>
>> Generates and sends a local SIP request.
>>
>> Parameters:
>> * method - request method
>> * RURI - request SIP URI
>> - * NEXT HOP - next hop SIP URI (OBP); use "." if no value.
>> - * socket - local socket to be used for sending the request; use
>> "."
>> + * NEXT HOP - next hop SIP URI (OBP); use “.” if no value.
>> + * socket - local socket to be used for sending the request; use
>> “.”
>> if no value.
>> * headers - set of additional headers to be added to the
>> request; at
>> - least "From" and "To" headers must be specify)
>> + least “From” and “To” headers must be specify)
>> * body - (optional, may not be present) request body (if present,
>> - requires the "Content-Type" and "Content-length" headers)
>> + requires the “Content-Type” and “Content-length” headers)
>>
>> -5.2. t_uac_cancel
>> +5.2. t_uac_cancel
>>
>> Generates and sends a CANCEL for an existing local SIP request.
>>
>> @@ -176,14 +222,14 @@ if (t_cancel_branches("all")) {
>> * callid - callid of the INVITE request to be cancelled.
>> * cseq - cseq of the INVITE request to be cancelled.
>>
>> -5.3. t_hash
>> +5.3. t_hash
>>
>> Gets information about the load of TM internal hash table.
>>
>> Parameters:
>> * none
>>
>> -5.4. t_reply
>> +5.4. t_reply
>>
>> Generates and sends a reply for an existing inbound SIP
>> transaction.
>>
>> @@ -193,9 +239,9 @@ if (t_cancel_branches("all")) {
>> * trans_id - transaction identifier (has the hash_entry:label
>> format)
>> * to_tag - To tag to be added to TO header
>> * new_headers - extra headers to be appended to the reply; use
>> a dot
>> - (".") char only if there are no headers;
>> + (“.”) char only if there are no headers;
>> * body - (optional, may not be present) reply body (if present,
>> - requires the "Content-Type" and "Content-length" headers)
>> + requires the “Content-Type” and “Content-length” headers)
>>
>> 6. Exported statistics
>>
>> @@ -212,7 +258,7 @@ if (t_cancel_branches("all")) {
>> 6.11. inuse_transactions
>>
>> Exported statistics are listed in the next sections. All statistics
>> - except "inuse_transactions" can be reset.
>> + except “inuse_transactions” can be reset.
>>
>> 6.1. received_replies
>>
>> diff --git a/modules_k/tmx/doc/tmx_admin.xml
>> b/modules_k/tmx/doc/tmx_admin.xml
>> index ac82335..7ba6c32 100644
>> --- a/modules_k/tmx/doc/tmx_admin.xml
>> +++ b/modules_k/tmx/doc/tmx_admin.xml
>> @@ -95,6 +95,82 @@ if (t_cancel_branches("all")) {
>> </programlisting>
>> </example>
>> </section>
>> + <section>
>> + <title>
>> + <function moreinfo="none">t_cancel_callid(callid, cseq, flag)
>> + </function>
>> + </title>
>> + <para>
>> + Cancel first INVITE transaction identified by callid and
>> cseq. It sets
>> + the flag if the value is greater than zero
>> + </para>
>> + <para>
>> + Parameters:.
>> + </para>
>> + <itemizedlist>
>> + <listitem><para>
>> + <emphasis>callid</emphasis> - call-id value.
>> + </para></listitem>
>> + <listitem><para>
>> + <emphasis>cseq</emphasis> - cseq number.
>> + </para></listitem>
>> + <listitem><para>
>> + <emphasis>flag</emphasis> - index of the flag to set.
>> + </para></listitem>
>> + </itemizedlist>
>> + <para>
>> + This function can be used in ANY_ROUTE.
>> + </para>
>> + <example>
>> + <title><function>t_cancel_callid</function> usage</title>
>> + <programlisting format="linespecific">
>> +...
>> +if (t_cancel_callid("123qaz", "5", "22")) {
>> + xlog("transaction cancelled\n");
>> +}
>> +...
>> +</programlisting>
>> + </example>
>> + </section>
>> + <section>
>> + <title>
>> + <function moreinfo="none">t_reply_callid(callid, cseq, code, reason)
>> + </function>
>> + </title>
>> + <para>
>> + Send reply to first INVITE transaction identified by callid
>> and cseq.
>> + </para>
>> + <para>
>> + Parameters:.
>> + </para>
>> + <itemizedlist>
>> + <listitem><para>
>> + <emphasis>callid</emphasis> - call-id value.
>> + </para></listitem>
>> + <listitem><para>
>> + <emphasis>cseq</emphasis> - cseq number.
>> + </para></listitem>
>> + <listitem><para>
>> + <emphasis>code</emphasis> - reply code.
>> + </para></listitem>
>> + <listitem><para>
>> + <emphasis>reason</emphasis> - reply reason.
>> + </para></listitem>
>> + </itemizedlist>
>> + <para>
>> + This function can be used in ANY_ROUTE.
>> + </para>
>> + <example>
>> + <title><function>t_cancel_reply</function> usage</title>
>> + <programlisting format="linespecific">
>> +...
>> +if (t_cancel_callid("123qaz", "5", "458", "Replied remotely")) {
>> + xlog("transaction replied\n");
>> +}
>> +...
>> +</programlisting>
>> + </example>
>> + </section>
>> </section>
>>
>> <section>
>>
>>
>>
>>
>> _______________________________________________
>> sr-dev mailing list
>> sr-dev at lists.sip-router.org
>> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
>
> _______________________________________________
> sr-dev mailing list
> sr-dev at lists.sip-router.org
> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
--
Daniel-Constantin Mierla
* http://www.asipto.com/
* http://twitter.com/miconda
* http://www.linkedin.com/in/danielconstantinmierla
More information about the sr-dev
mailing list