You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/lib/cds/doc/msg_queue_destroy.xml

55 lines
1.6 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="msg_queue_destroy"> <!-- ID for references -->
<refmeta>
<refentrytitle>msg_queue_destroy</refentrytitle> <!-- title shown in references -->
<manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
<refnamediv>
<refname>msg_queue_destroy</refname> <!-- function name -->
<refpurpose>destroy message queue</refpurpose> <!-- short function description -->
</refnamediv>
<refsynopsisdiv><funcsynopsis>
<funcsynopsisinfo>
#include &lt;cds/msg_queue.h&gt; <!-- included headers -->
</funcsynopsisinfo>
<funcprototype> <!-- function prototype -->
<funcdef>void <function>msg_queue_destroy</function></funcdef>
<paramdef>msg_queue_t *<parameter>q</parameter></paramdef>
</funcprototype>
</funcsynopsis></refsynopsisdiv>
<refsect1><title>Description</title>
<para>Destroys initialized message queue. After calling
<function>msg_queue_destroy</function> can not be called any of message queue
manipulation functions except <function>msg_queue_init</function>.
<!-- detailed description -->
</para>
<para>All messages which stay in the queue
are automaticaly freed using <function>free_message</function>.
</para>
</refsect1>
<refsect1><title>See Also</title>
<para>
<xref linkend="msg_queue_init"/>, <xref linkend="msg_queue_init_ex"/>, <xref
linkend="msg_queue_t"/>, <xref linkend="mq_message_t"/>, <xref
linkend="free_message"/>, <xref linkend="init_message_ex"/>
<!--, <xref
linkend="free_message"/>-->
<!-- references to other pages -->
</para>
</refsect1>
</refentry>