2
0
Эх сурвалжийг харах

tm: docs for t_send_reply()

Daniel-Constantin Mierla 7 жил өмнө
parent
commit
0ae7e00152

+ 34 - 0
src/modules/tm/doc/functions.xml

@@ -360,6 +360,40 @@ t_reply("404", "Not found");
 	</example>
     </section>
 
+    <section id="tm.f.t_send_reply">
+	<title>
+	    <function>t_semd_reply(code, reason)</function>
+	</title>
+	<para>
+	    Creates the transaction if it does not exist (executing internally
+		t_newtran()) and sends a stateful reply (executing internally
+		t_reply()). If transaction exists, this function does not stop the
+		execution of config, t_reply() being still executed.
+	</para>
+	<para>
+		For more, see the docs for t_newtran() and t_reply().
+	</para>
+	<para>Meaning of the parameters is as follows:</para>
+	<itemizedlist>
+	    <listitem>
+		<para><emphasis>code</emphasis> - Reply code number.
+		</para>
+	    </listitem>
+	    <listitem>
+		<para><emphasis>reason</emphasis> - Reason string.
+		</para>
+	    </listitem>
+	</itemizedlist>
+	<example>
+	    <title><function>t_send_reply</function> usage</title>
+	    <programlisting>
+...
+t_send_reply("404", "Not found");
+...
+	    </programlisting>
+	</example>
+    </section>
+
     <section id="tm.f.t_lookup_request">
 	<title>
 	    <function>t_lookup_request()</function>