libbonobo2-dev 2.24.3-1 / usr / share / gtk-doc / html / libbonobo / libbonobo-bonobo-stream-memory.html

This file is indexed.

/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-stream-memory.html is in libbonobo2-dev 2.24.3-1.

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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboStreamMem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="streams.html" title="Storages and Streams">
<link rel="prev" href="libbonobo-bonobo-storage-memory.html" title="bonobo-storage-memory">
<link rel="next" href="libbonobo-bonobo-storage.html" title="bonobo-storage">
<meta name="generator" content="GTK-Doc V1.14 (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="libbonobo-bonobo-storage-memory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="streams.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">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-storage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-stream-memory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-stream-memory.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-stream-memory.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="BonoboStreamMem">
<a name="libbonobo-bonobo-stream-memory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-stream-memory.top_of_page"></a>BonoboStreamMem</span></h2>
<p>BonoboStreamMem — In-memory implementation of Bonobo::Stream interface.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libbonobo-bonobo-stream-memory.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboStreamMem"></a><pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem-struct" title="BonoboStreamMem">BonoboStreamMem</a>;
                    <a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMemClass" title="BonoboStreamMemClass">BonoboStreamMemClass</a>;
<a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="returnvalue">BonoboStreamMem</span></a> *   <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-construct" title="bonobo_stream_mem_construct ()">bonobo_stream_mem_construct</a>         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);
<a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="returnvalue">BonoboObject</span></a> *      <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-create" title="bonobo_stream_mem_create ()">bonobo_stream_mem_create</a>            (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-buffer" title="bonobo_stream_mem_get_buffer ()">bonobo_stream_mem_get_buffer</a>        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);
<span class="returnvalue">size_t</span>              <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-size" title="bonobo_stream_mem_get_size ()">bonobo_stream_mem_get_size</a>          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="libbonobo-bonobo-stream-memory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----BonoboStreamMem
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libbonobo-bonobo-stream-memory.description"></a><h2>Description</h2>
<p>
   The BonoboStreamMem is an implementation of the
   IDL:Bonobo/Stream:1.0 interface.  This implementation allows an
   in-memory buffer to be exposed as a IDL:Bonobo/Stream:1.0 to
   clients.
</p>
<p>
   Here is a sample way of exposing a C string as an
   IDL:Bonobo/Stream:1.0:
   </p>
<div class="example">
<a name="id435550"></a><p class="title"><b>Example 22. Sample BonoboStreamMem usage</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
        <td class="listing_code"><pre class="programlisting">BonoboStream <span class="symbol">*</span><span class="function">make_bonobo_stream_on_string</span> <span class="symbol">(</span><span class="gtkdoc kwb">char</span> <span class="symbol">*</span>string<span class="symbol">)</span>
<span class="symbol">{</span>
    <span class="keyword">return</span> <span class="function"><a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-create">bonobo_stream_mem_create</a></span> <span class="symbol">(</span>string<span class="symbol">,</span> <span class="function">strlen</span> <span class="symbol">(</span>string<span class="symbol">),</span> TRUE<span class="symbol">,</span> FALSE<span class="symbol">);</span>
<span class="symbol">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
   This example will make the string argument be exposed as a CORBA
   stream.  </p>
</div>
<div class="refsect1" title="Details">
<a name="libbonobo-bonobo-stream-memory.details"></a><h2>Details</h2>
<div class="refsect2" title="BonoboStreamMem">
<a name="BonoboStreamMem-struct"></a><h3>BonoboStreamMem</h3>
<pre class="programlisting">typedef struct _BonoboStreamMem BonoboStreamMem;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="BonoboStreamMemClass">
<a name="BonoboStreamMemClass"></a><h3>BonoboStreamMemClass</h3>
<pre class="programlisting">typedef struct {
	BonoboObjectClass parent_class;

	POA_Bonobo_Stream__epv epv;

	char           *(*get_buffer) (BonoboStreamMem *stream_mem);
	size_t          (*get_size)   (BonoboStreamMem *stream_mem);
} BonoboStreamMemClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="bonobo_stream_mem_construct ()">
<a name="bonobo-stream-mem-construct"></a><h3>bonobo_stream_mem_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="returnvalue">BonoboStreamMem</span></a> *   bonobo_stream_mem_construct         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resizable</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="bonobo_stream_mem_create ()">
<a name="bonobo-stream-mem-create"></a><h3>bonobo_stream_mem_create ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="returnvalue">BonoboObject</span></a> *      bonobo_stream_mem_create            (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);</pre>
<p>
Creates a new BonoboStreamMem object.
</p>
<p>
If <em class="parameter"><code>buffer</code></em> is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>size</code></em> bytes are copied from it into a new
buffer. If <em class="parameter"><code>buffer</code></em> is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a new buffer of size <em class="parameter"><code>size</code></em> is created
and filled with zero bytes.
</p>
<p>
When data is read out of or (if <em class="parameter"><code>read_only</code></em> is FALSE) written into
the returned BonoboStream object, the <code class="function">read()</code> and <code class="function">write()</code> operations
operate on the new buffer. If <em class="parameter"><code>resizable</code></em> is TRUE, writing or seeking
past the end of the buffer will cause the buffer to be expanded (with
the new space zero-filled for a seek).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>The data for which a BonoboStreamMem object is to be created.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>The size in bytes of <em class="parameter"><code>buffer</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
<td>Specifies whether or not the returned BonoboStreamMem
object should allow <code class="function">write()</code> operations.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resizable</code></em> :</span></p></td>
<td>Whether or not the buffer should be resized as needed.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the constructed BonoboStream object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="bonobo_stream_mem_get_buffer ()">
<a name="bonobo-stream-mem-get-buffer"></a><h3>bonobo_stream_mem_get_buffer ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        bonobo_stream_mem_get_buffer        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);</pre>
<p>
Returns the buffer associated with a BonoboStreamMem. If the stream
is set to automatically resize itself, this buffer is only guaranteed
to stay valid until the next write operation on the stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>a BonoboStreamMem
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a buffer containing the data written to the stream (or
the data the stream was initialized with if nothing has been written).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="bonobo_stream_mem_get_size ()">
<a name="bonobo-stream-mem-get-size"></a><h3>bonobo_stream_mem_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span>              bonobo_stream_mem_get_size          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);</pre>
<p>
Returns the size of the data associated with a BonoboStreamMem
see bonobo_stream_mem_get_buffer
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>a BonoboStreamMem
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the size.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="libbonobo-bonobo-stream-memory.see-also"></a><h2>See Also</h2>
<p>
  </p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">BonoboStream</span></span></p></td>
<td><p>An abstract class to implement
      IDL:Bonobo/Streams.</p></td>
</tr>
<tr>
<td><p><span class="term">IDL:Bonobo/Stream:1.0</span></p></td>
<td><p>The CORBA interface implemented .</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.