File: //usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-stream-memory.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>BonoboStreamMem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" 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.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="general.html" title="General">
<link rel="chapter" href="factories.html" title="Objects, Factories, Reference Counting">
<link rel="chapter" href="property-bags.html" title="Property Bags, Events, Listeners">
<link rel="chapter" href="monikers.html" title="Monikers">
<link rel="chapter" href="streams.html" title="Storages and Streams">
<link rel="chapter" href="persist.html" title="Persistency">
<link rel="chapter" href="misc.html" title="Miscellaneous">
</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"><nobr><a href="#id2774468" class="shortcut">Top</a>
 | 
<a href="#id2775763" class="shortcut">Description</a>
 | 
<a href="#id2775731" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libbonobo-bonobo-stream-memory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2774468"></a><span class="refentrytitle">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">
<h2>Synopsis</h2>
<a name="BonoboStreamMem"></a><pre class="synopsis">
<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem-struct">BonoboStreamMem</a>;
<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMemClass">BonoboStreamMemClass</a>;
<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a>* <a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-construct">bonobo_stream_mem_construct</a>
(<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem,
const char *buffer,
size_t size,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> read_only,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> resizable);
<a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* <a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-create">bonobo_stream_mem_create</a> (const char *buffer,
size_t size,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> read_only,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> resizable);
const char* <a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-buffer">bonobo_stream_mem_get_buffer</a> (<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem);
size_t <a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-size">bonobo_stream_mem_get_size</a> (<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2775731"></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 href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
+----BonoboStreamMem
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2775763"></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="id2775784"></a><p class="title"><b>Example 1. Sample BonoboStreamMem usage</b></p>
<pre class="programlisting">
BonoboStream *make_bonobo_stream_on_string (char *string)
{
return bonobo_stream_mem_create (string, strlen (string), TRUE, FALSE);
}
</pre>
</div>
<p>
This example will make the string argument be exposed as a CORBA
stream. </p>
</div>
<div class="refsect1" lang="en">
<a name="id2775802"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2775813"></a><h3>
<a name="BonoboStreamMem-struct"></a>BonoboStreamMem</h3>
<a class="indexterm" name="id2775826"></a><pre class="programlisting">typedef struct _BonoboStreamMem BonoboStreamMem;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2775841"></a><h3>
<a name="BonoboStreamMemClass"></a>BonoboStreamMemClass</h3>
<a class="indexterm" name="id2775854"></a><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" lang="en">
<a name="id2775873"></a><h3>
<a name="bonobo-stream-mem-construct"></a>bonobo_stream_mem_construct ()</h3>
<a class="indexterm" name="id2775886"></a><pre class="programlisting"><a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a>* bonobo_stream_mem_construct
(<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem,
const char *buffer,
size_t size,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> read_only,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> resizable);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>buffer</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>read_only</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>resizable</code></em> :</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2776028"></a><h3>
<a name="bonobo-stream-mem-create"></a>bonobo_stream_mem_create ()</h3>
<a class="indexterm" name="id2776042"></a><pre class="programlisting"><a href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>* bonobo_stream_mem_create (const char *buffer,
size_t size,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> read_only,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> resizable);</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/liboil/liboil-liboiljunk.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/liboil/liboil-liboiljunk.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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>buffer</code></em> :</span></td>
<td> The data for which a BonoboStreamMem object is to be created.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>size</code></em> :</span></td>
<td> The size in bytes of <em class="parameter"><code>buffer</code></em>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>read_only</code></em> :</span></td>
<td> Specifies whether or not the returned BonoboStreamMem
object should allow <code class="function">write()</code> operations.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>resizable</code></em> :</span></td>
<td> Whether or not the buffer should be resized as needed.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the constructed BonoboStream object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2776279"></a><h3>
<a name="bonobo-stream-mem-get-buffer"></a>bonobo_stream_mem_get_buffer ()</h3>
<a class="indexterm" name="id2776292"></a><pre class="programlisting">const char* bonobo_stream_mem_get_buffer (<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem);</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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></td>
<td> a BonoboStreamMem
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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" lang="en">
<a name="id2776360"></a><h3>
<a name="bonobo-stream-mem-get-size"></a>bonobo_stream_mem_get_size ()</h3>
<a class="indexterm" name="id2776374"></a><pre class="programlisting">size_t bonobo_stream_mem_get_size (<a href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem">BonoboStreamMem</a> *stream_mem);</pre>
<p>
Returns the size of the data associated with a BonoboStreamMem
see bonobo_stream_mem_get_buffer</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></td>
<td> a BonoboStreamMem
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the size.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2776437"></a><h2>See Also</h2>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><span class="type">BonoboStream</span></span></td>
<td><p>An abstract class to implement
IDL:Bonobo/Streams.</p></td>
</tr>
<tr>
<td>
<span class="term">IDL:Bonobo/Stream:1.0</span></td>
<td><p>The CORBA interface implemented .</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
</body>
</html>