/usr/share/gtk-doc/html/camel/CamelStream.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
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 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="Streams.html" title="Streams">
<link rel="next" href="CamelStreamBuffer.html" title="CamelStreamBuffer">
<meta name="generator" content="GTK-Doc V1.18 (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="Streams.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">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelStreamBuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelStream.synopsis" class="shortcut">Top</a>
|
<a href="#CamelStream.description" class="shortcut">Description</a>
|
<a href="#CamelStream.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelStream.top_of_page"></a>CamelStream</span></h2>
<p>CamelStream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelStream.html#CamelStream-struct" title="struct CamelStream">CamelStream</a>;
<span class="returnvalue">gssize</span> <a class="link" href="CamelStream.html#camel-stream-read" title="camel_stream_read ()">camel_stream_read</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gssize</span> <a class="link" href="CamelStream.html#camel-stream-write" title="camel_stream_write ()">camel_stream_write</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelStream.html#camel-stream-flush" title="camel_stream_flush ()">camel_stream_flush</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelStream.html#camel-stream-close" title="camel_stream_close ()">camel_stream_close</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="CamelStream.html#camel-stream-eos" title="camel_stream_eos ()">camel_stream_eos</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);
<span class="returnvalue">gssize</span> <a class="link" href="CamelStream.html#camel-stream-write-string" title="camel_stream_write_string ()">camel_stream_write_string</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gssize</span> <a class="link" href="CamelStream.html#camel-stream-write-to-stream" title="camel_stream_write_to_stream ()">camel_stream_write_to_stream</a> (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *output_stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelStream
+----<a class="link" href="CamelHttpStream.html" title="CamelHttpStream">CamelHttpStream</a>
+----<a class="link" href="CamelStreamBuffer.html" title="CamelStreamBuffer">CamelStreamBuffer</a>
+----<a class="link" href="CamelStreamFilter.html" title="CamelStreamFilter">CamelStreamFilter</a>
+----<a class="link" href="CamelStreamFs.html" title="CamelStreamFs">CamelStreamFs</a>
+----<a class="link" href="CamelStreamMem.html" title="CamelStreamMem">CamelStreamMem</a>
+----<a class="link" href="CamelStreamNull.html" title="CamelStreamNull">CamelStreamNull</a>
+----<a class="link" href="CamelStreamProcess.html" title="CamelStreamProcess">CamelStreamProcess</a>
+----<a class="link" href="CamelStreamVFS.html" title="CamelStreamVFS">CamelStreamVFS</a>
+----<a class="link" href="CamelTcpStream.html" title="CamelTcpStream">CamelTcpStream</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelStream.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelStream.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelStream-struct"></a><h3>struct CamelStream</h3>
<pre class="programlisting">struct CamelStream;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-read"></a><h3>camel_stream_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gssize</span> camel_stream_read (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempts to read up to <em class="parameter"><code>len</code></em> bytes from <em class="parameter"><code>stream</code></em> into <em class="parameter"><code>buf</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>output buffer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>max number of bytes to read.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of bytes actually read, or <code class="literal">-1</code> on error and set
errno.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-write"></a><h3>camel_stream_write ()</h3>
<pre class="programlisting"><span class="returnvalue">gssize</span> camel_stream_write (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gsize</span> n</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempts to write up to <em class="parameter"><code>n</code></em> bytes of <em class="parameter"><code>buffer</code></em> into <em class="parameter"><code>stream</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>buffer to write.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td>number of bytes to write</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of bytes written to the stream, or <code class="literal">-1</code> on error
along with setting errno.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-flush"></a><h3>camel_stream_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_stream_flush (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Flushes any buffered data to the stream's backing store. Only
meaningful for writable streams.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">0</code> on success or <code class="literal">-1</code> on fail along with setting <em class="parameter"><code>error</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-close"></a><h3>camel_stream_close ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_stream_close (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Closes 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</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">0</code> on success or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-eos"></a><h3>camel_stream_eos ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_stream_eos (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>);</pre>
<p>
Tests if there are bytes left to read on the <em class="parameter"><code>stream</code></em> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> on EOS or <code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-write-string"></a><h3>camel_stream_write_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gssize</span> camel_stream_write_string (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *string</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Writes the string to 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</code></em> :</span></p></td>
<td>a <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>a string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the number of characters written or <code class="literal">-1</code> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-write-to-stream"></a><h3>camel_stream_write_to_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">gssize</span> camel_stream_write_to_stream (<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> *output_stream</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Write all of a stream (until eos) into another stream, in a
blocking fashion.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>source <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>output_stream</code></em> :</span></p></td>
<td>destination <a class="link" href="CamelStream.html" title="CamelStream"><span class="type">CamelStream</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">-1</code> on error, or the number of bytes succesfully
copied across streams.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|