core, lib, modules: restructured source code tree
[sip-router] / src / lib / cds / doc / msg_queue_init.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
4    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5
6 <refentry id="msg_queue_init"> <!-- ID for references -->
7
8 <refmeta>
9 <refentrytitle>msg_queue_init</refentrytitle> <!-- title shown in references -->
10 <manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
11
12 <refnamediv>
13 <refname>msg_queue_init</refname> <!-- function name -->
14 <refpurpose>message queue initialization</refpurpose> <!-- short function description -->
15 </refnamediv>
16
17 <refsynopsisdiv><funcsynopsis>
18 <funcsynopsisinfo>
19 #include &lt;cds/msg_queue.h&gt; <!-- included headers -->
20 </funcsynopsisinfo>
21
22 <funcprototype> <!-- function prototype -->
23   <funcdef>int <function>msg_queue_init</function></funcdef>
24   <paramdef>msg_queue_t *<parameter>q</parameter></paramdef>
25 </funcprototype>
26
27 </funcsynopsis></refsynopsisdiv>
28
29 <refsect1><title>Description</title>
30 <para>Initializes synchronized (using internal mutex) message queue structure.
31 <!-- detailed description -->
32 </para>
33
34 </refsect1>
35
36 <refsect1><title>Return value</title>
37 <para>
38 <!-- return value description -->
39 Returns 0 on success, non-zero on error.
40 </para>
41 </refsect1>
42
43 <refsect1><title>See Also</title>
44 <para>
45 <xref linkend="msg_queue_init_ex"/>, <xref linkend="msg_queue_destroy"/>
46 <!-- references to other pages -->
47 </para>
48 </refsect1>
49
50 </refentry> 
51