modules/ims_qos: added patch for flow-description bug when request originates from...
[sip-router] / src / lib / cds / doc / push_message.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="push_message"> <!-- ID for references -->
7
8 <refmeta>
9 <refentrytitle>push_message</refentrytitle> <!-- title shown in references -->
10 <manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
11
12 <refnamediv>
13 <refname>push_message</refname> <!-- function name -->
14 <refpurpose>push message into message queue</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>push_message</function></funcdef>
24   <paramdef>msg_queue_t *<parameter>q</parameter></paramdef>
25   <paramdef>mq_message_t *<parameter>msg</parameter></paramdef>
26 </funcprototype>
27
28 </funcsynopsis></refsynopsisdiv>
29
30 <refsect1><title>Description</title>
31 <para>Function pushes initialized message into message queue. This
32 message may be removed from the queue using <function>pop_message</function>.
33 Unremoved messages are automaticaly freed by <function>msg_queue_destroy</function> 
34 (depending on message initialization, see <xref
35 linkend="create_message"/>, <xref linkend="create_message_ex"/> and <xref
36 linkend="init_message_ex"/>).
37 <!-- detailed description -->
38 </para>
39
40 </refsect1>
41
42 <refsect1><title>Return value</title>
43 <para>
44 <!-- return value description -->
45 Returns 0 on success, non-zero on error.
46 </para>
47 </refsect1>
48
49 <refsect1><title>See Also</title>
50 <para>
51 <!-- references to other pages -->
52 <xref linkend="pop_message"/>, 
53 <xref linkend="create_message"/>, 
54 <xref linkend="create_message_ex"/>, 
55 <xref linkend="init_message_ex"/>
56 </para>
57 </refsect1>
58
59 </refentry> 
60