/usr/share/doc/liborbit2-dev/ORBit2/ORBit2-orbit2-allocators.html is in liborbit2-dev 1:2.14.19-0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Allocators</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="ORBit2 Reference Manual">
<link rel="up" href="general.html" title="API">
<link rel="prev" href="general.html" title="API">
<link rel="next" href="ORBit2-orbit2-small.html" title="orbit2-small">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="general.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ORBit2 Reference Manual</th>
<td><a accesskey="n" href="ORBit2-orbit2-small.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ORBit2-orbit2-allocators.synopsis" class="shortcut">Top</a>
|
<a href="#ORBit2-orbit2-allocators.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ORBit2-orbit2-allocators"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ORBit2-orbit2-allocators.top_of_page"></a>Allocators</span></h2>
<p>Allocators — Memory allocation functions for CORBA types.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ORBit2-orbit2-allocators.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-set-release" title="CORBA_sequence_set_release()">CORBA_sequence_set_release</a> (s,
r)
#define <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-get-release" title="CORBA_sequence_get_release()">CORBA_sequence_get_release</a> (s)
<span class="returnvalue">void</span> <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-free" title="CORBA_free ()">CORBA_free</a> (<em class="parameter"><code><span class="type">gpointer</span> mem</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="ORBit2-orbit2-allocators.html#ORBit-alloc-tcval" title="ORBit_alloc_tcval ()">ORBit_alloc_tcval</a> (<em class="parameter"><code><span class="type">CORBA_TypeCode</span> tc</code></em>,
<em class="parameter"><code><span class="type">guint</span> nelements</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="ORBit2-orbit2-allocators.html#ORBit-realloc-tcval" title="ORBit_realloc_tcval ()">ORBit_realloc_tcval</a> (<em class="parameter"><code><span class="type">gpointer</span> old</code></em>,
<em class="parameter"><code><span class="type">CORBA_TypeCode</span> tc</code></em>,
<em class="parameter"><code><span class="type">guint</span> old_num_elements</code></em>,
<em class="parameter"><code><span class="type">guint</span> num_elements</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ORBit2-orbit2-allocators.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="ORBit2-orbit2-allocators.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CORBA-sequence-set-release"></a><h3>CORBA_sequence_set_release()</h3>
<pre class="programlisting">#define CORBA_sequence_set_release(s,r) (s)->_release = r
</pre>
<p>
<a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-set-release" title="CORBA_sequence_set_release()"><code class="function">CORBA_sequence_set_release()</code></a> can be used to set the state of the
release flag. If the flag is set to <code class="literal">TRUE</code>, the sequence effectively
"owns" the storage pointed to by <em class="structfield"><code>_buffer</code></em>; if
<code class="literal">FALSE</code>, the programmer is responsible for the storage. If, for
example, a sequence is returned from an operation with its release
flag set to <code class="literal">FALSE</code>, calling <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-free" title="CORBA_free ()"><code class="function">CORBA_free()</code></a> on the returned sequence
pointer will not deallocate the memory pointed to by
<em class="structfield"><code>_buffer</code></em>.
</p>
<p>
Also, passing a null pointer or a pointer to something other than
a sequence type to either <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-set-release" title="CORBA_sequence_set_release()"><code class="function">CORBA_sequence_set_release()</code></a> or
<a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-get-release" title="CORBA_sequence_get_release()"><code class="function">CORBA_sequence_get_release()</code></a> produces undefined behavior.
</p>
<p>
<a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-set-release" title="CORBA_sequence_set_release()"><code class="function">CORBA_sequence_set_release()</code></a> should only be used by the creator of a
sequence. If it is not called for a given sequence instance, then
the default value of the release flag for that instance is <code class="literal">FALSE</code>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td>a CORBA sequence</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
<td>the new value of the release flag</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CORBA-sequence-get-release"></a><h3>CORBA_sequence_get_release()</h3>
<pre class="programlisting">#define CORBA_sequence_get_release(s) (s)->_release
</pre>
<p>
Before calling <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-free" title="CORBA_free ()"><code class="function">CORBA_free()</code></a> on the
<em class="structfield"><code>_buffer</code></em> member of a sequence directly,
the programmer should check the release flag using
<a class="link" href="ORBit2-orbit2-allocators.html#CORBA-sequence-get-release" title="CORBA_sequence_get_release()"><code class="function">CORBA_sequence_get_release()</code></a>. If it returns <code class="literal">FALSE</code>, the programmer
should not invoke <a class="link" href="ORBit2-orbit2-allocators.html#CORBA-free" title="CORBA_free ()"><code class="function">CORBA_free()</code></a> on the
<em class="structfield"><code>_buffer</code></em> member; doing so produces
undefined behavior.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td>a CORBA sequence</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CORBA-free"></a><h3>CORBA_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> CORBA_free (<em class="parameter"><code><span class="type">gpointer</span> mem</code></em>);</pre>
<p>
This function should be used to free memory that has been
previously allocated with any CORBA memory allocation function.
It does deep/recursive/intelligent deallocation of memory,
including deallocation of values of <span class="type">CORBA_any</span> types,
sequence buffers and elements, etc.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mem</code></em> :</span></p></td>
<td>pointer to any memory block allocated by CORBA/ORBit</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ORBit-alloc-tcval"></a><h3>ORBit_alloc_tcval ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> ORBit_alloc_tcval (<em class="parameter"><code><span class="type">CORBA_TypeCode</span> tc</code></em>,
<em class="parameter"><code><span class="type">guint</span> nelements</code></em>);</pre>
<p>
Allocates a memory buffer that can hold <em class="parameter"><code>nelemems</code></em> elements of type <em class="parameter"><code>tc</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>tc</code></em> :</span></p></td>
<td>typecode of the elements of the array</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nelements</code></em> :</span></p></td>
<td>number of elements of the array</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the address of the newly allocated memory buffer</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ORBit-realloc-tcval"></a><h3>ORBit_realloc_tcval ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> ORBit_realloc_tcval (<em class="parameter"><code><span class="type">gpointer</span> old</code></em>,
<em class="parameter"><code><span class="type">CORBA_TypeCode</span> tc</code></em>,
<em class="parameter"><code><span class="type">guint</span> old_num_elements</code></em>,
<em class="parameter"><code><span class="type">guint</span> num_elements</code></em>);</pre>
<p>
Changes the size of a CORBA memory buffer.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>old</code></em> :</span></p></td>
<td>old memory segment, possibly allocated by <a class="link" href="ORBit2-orbit2-allocators.html#ORBit-alloc-tcval" title="ORBit_alloc_tcval ()"><code class="function">ORBit_alloc_tcval()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tc</code></em> :</span></p></td>
<td>typecode of the elements of the array</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>old_num_elements</code></em> :</span></p></td>
<td>current number of elements of the array</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num_elements</code></em> :</span></p></td>
<td>new desired size of the array</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new location of the array</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|