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_init.xml

52 lines
1.4 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_init"> <!-- ID for references -->
<refmeta>
<refentrytitle>msg_queue_init</refentrytitle> <!-- title shown in references -->
<manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
<refnamediv>
<refname>msg_queue_init</refname> <!-- function name -->
<refpurpose>message queue initialization</refpurpose> <!-- short function description -->
</refnamediv>
<refsynopsisdiv><funcsynopsis>
<funcsynopsisinfo>
#include &lt;cds/msg_queue.h&gt; <!-- included headers -->
</funcsynopsisinfo>
<funcprototype> <!-- function prototype -->
<funcdef>int <function>msg_queue_init</function></funcdef>
<paramdef>msg_queue_t *<parameter>q</parameter></paramdef>
</funcprototype>
</funcsynopsis></refsynopsisdiv>
<refsect1><title>Description</title>
<para>Initializes synchronized (using internal mutex) message queue structure.
<!-- detailed description -->
</para>
</refsect1>
<refsect1><title>Return value</title>
<para>
<!-- return value description -->
Returns 0 on success, non-zero on error.
</para>
</refsect1>
<refsect1><title>See Also</title>
<para>
<xref linkend="msg_queue_init_ex"/>, <xref linkend="msg_queue_destroy"/>
<!-- references to other pages -->
</para>
</refsect1>
</refentry>