Browse code

tcpops: docs for tcp_close_connection()

Daniel-Constantin Mierla authored on 23/06/2021 06:40:46
Showing 1 changed files
... ...
@@ -375,4 +375,40 @@ event_route[tcp:closed] {
375 375
 			]]></programlisting>
376 376
 		</example>
377 377
 	</section>
378
+	<section id="tcpops.f.tcp_close_connection">
379
+		<title>
380
+			<function>tcp_close_connection([conid])</function>
381
+		</title>
382
+		<para>
383
+			Trigger a close of the connection corresponding to current SIP
384
+			message or to connection id 'conid'.
385
+		</para>
386
+		<para>Meaning of the parameters is as follows:</para>
387
+		<itemizedlist>
388
+			<listitem>
389
+				<para><emphasis>conid</emphasis> - the value of tcp connection id.
390
+				It can be an integer number or a variable holding an interver value.
391
+				</para>
392
+			</listitem>
393
+		</itemizedlist>
394
+		<para>Return values:</para>
395
+		<itemizedlist>
396
+			<listitem>
397
+			<para>1: success</para>
398
+			</listitem>
399
+			<listitem>
400
+			<para>-1 (or other negative values): failure</para>
401
+			</listitem>
402
+		</itemizedlist>
403
+		<example>
404
+			<title><function>tcp_close_connection</function> usage</title>
405
+			<programlisting><![CDATA[
406
+...
407
+	$var(conid) = 10;
408
+	tcp_close_connection("$var(conid)");
409
+...
410
+			]]></programlisting>
411
+		</example>
412
+	</section>
413
+
378 414
 </section>