modules/ims_qos: added patch for flow-description bug when request originates from...
[sip-router] / lib / cds / doc / create_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="create_message"> <!-- ID for references -->
7
8 <refmeta>
9 <refentrytitle>create_message</refentrytitle> <!-- title shown in references -->
10 <manvolnum>3</manvolnum></refmeta> <!-- man volume id (3 for libraries) -->
11
12 <refnamediv>
13 <refname>create_message</refname> <!-- function name -->
14 <refpurpose>allocates and initializes message</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>create_message</function></funcdef>
24   <paramdef>void *<parameter>data</parameter></paramdef>
25   <paramdef>int <parameter>data_len</parameter></paramdef>
26 </funcprototype>
27
28 </funcsynopsis></refsynopsisdiv>
29
30 <refsect1><title>Description</title>
31
32 <para>Allocates message using <function>cds_malloc</function> and initializes
33 its content so it will be freed automaticaly. Pointer to the explicitly
34 allocated data is set to <parameter>data</parameter> and its length is set to
35 <parameter>data_len</parameter>. Message created by <function>create_message</function> 
36 should be freed using <function>message_free</function>.</para>
37
38 <para>Unremoved messages created this way are freed automaticaly in
39 <function>msg_queue_destroy</function> using <function>free_message</function>.
40 </para>
41
42 <para>Calling <function>free_message</function> to such message frees the
43 message and the data given by parameter <parameter>data</parameter> too, thus
44 they can NOT be freed by the caller!
45 </para>
46
47 </refsect1>
48
49 <refsect1><title>Return value</title>
50 <para>
51 <!-- return value description -->
52 Returns NULL on error, pointer to initialized message structure otherwise.
53 </para>
54 </refsect1>
55
56 <refsect1><title>See Also</title>
57 <para>
58 <xref linkend="create_message_ex"/>, <xref linkend="init_message_ex"/>
59 <!-- references to other pages -->
60 </para>
61 </refsect1>
62
63 </refentry> 
64