| Server IP : 182.53.201.61 / Your IP : 216.73.217.175 Web Server : Apache/2.2.15 (Fedora) System : Linux km10.dyndns.org 2.6.31.5-127.fc12.i686.PAE #1 SMP Sat Nov 7 21:25:57 EST 2009 i686 User : apache ( 48) PHP Version : 5.3.3 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/gtk-doc/html/camel/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelSeekableStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Streams.html" title="Streams">
<link rel="prev" href="camel-CamelStream.html" title="CamelStream">
<link rel="next" href="camel-CamelSeekableSubstream.html" title="CamelSeekableSubstream">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="classes.html" title="Part I. Camel Classes">
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
<link rel="chapter" href="Streams.html" title="Streams">
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Filters.html" title="Filters">
<link rel="chapter" href="Folders.html" title="Folders">
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
<link rel="chapter" href="Addresses.html" title="Addresses">
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
<link rel="chapter" href="MIME.html" title="MIME Objects">
<link rel="chapter" href="Storage.html" title="Metadata Storage">
<link rel="chapter" href="Utilities.html" title="Utilities">
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
</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="camel-CamelStream.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="camel-CamelSeekableSubstream.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-CamelSeekableStream.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelSeekableStream.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelSeekableStream">
<a name="camel-CamelSeekableStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelSeekableStream.top_of_page"></a>CamelSeekableStream</span></h2>
<p>CamelSeekableStream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelSeekableStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
struct <a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a>;
enum <a class="link" href="camel-CamelSeekableStream.html#CamelStreamSeekPolicy" title="enum CamelStreamSeekPolicy">CamelStreamSeekPolicy</a>;
#define <a class="link" href="camel-CamelSeekableStream.html#CAMEL-STREAM-UNBOUND--CAPS" title="CAMEL_STREAM_UNBOUND">CAMEL_STREAM_UNBOUND</a>
off_t <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-seek" title="camel_seekable_stream_seek ()">camel_seekable_stream_seek</a> (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream,
off_t offset,
<a class="link" href="camel-CamelSeekableStream.html#CamelStreamSeekPolicy" title="enum CamelStreamSeekPolicy">CamelStreamSeekPolicy</a> policy);
off_t <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-tell" title="camel_seekable_stream_tell ()">camel_seekable_stream_tell</a> (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-set-bounds" title="camel_seekable_stream_set_bounds ()">camel_seekable_stream_set_bounds</a> (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream,
off_t start,
off_t end);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelSeekableStream.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelSeekableStream.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelSeekableStream">
<a name="CamelSeekableStream"></a><h3>struct CamelSeekableStream</h3>
<pre class="programlisting">struct CamelSeekableStream {
CamelStream parent_object;
off_t position; /* current postion in the stream */
off_t bound_start; /* first valid position */
off_t bound_end; /* first invalid position */
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="enum CamelStreamSeekPolicy">
<a name="CamelStreamSeekPolicy"></a><h3>enum CamelStreamSeekPolicy</h3>
<pre class="programlisting">typedef enum {
CAMEL_STREAM_SET = SEEK_SET,
CAMEL_STREAM_CUR = SEEK_CUR,
CAMEL_STREAM_END = SEEK_END
} CamelStreamSeekPolicy;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CAMEL_STREAM_UNBOUND">
<a name="CAMEL-STREAM-UNBOUND--CAPS"></a><h3>CAMEL_STREAM_UNBOUND</h3>
<pre class="programlisting">#define CAMEL_STREAM_UNBOUND (~0)
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_seekable_stream_seek ()">
<a name="camel-seekable-stream-seek"></a><h3>camel_seekable_stream_seek ()</h3>
<pre class="programlisting">off_t camel_seekable_stream_seek (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream,
off_t offset,
<a class="link" href="camel-CamelSeekableStream.html#CamelStreamSeekPolicy" title="enum CamelStreamSeekPolicy">CamelStreamSeekPolicy</a> policy);</pre>
<p>
Seek to the specified position in <em class="parameter"><code>stream</code></em>.
</p>
<p>
If <em class="parameter"><code>policy</code></em> is <span class="type">CAMEL_STREAM_SET</span>, seeks to <em class="parameter"><code>offset</code></em>.
</p>
<p>
If <em class="parameter"><code>policy</code></em> is <span class="type">CAMEL_STREAM_CUR</span>, seeks to the current position plus
<em class="parameter"><code>offset</code></em>.
</p>
<p>
If <em class="parameter"><code>policy</code></em> is <span class="type">CAMEL_STREAM_END</span>, seeks to the end of the stream plus
<em class="parameter"><code>offset</code></em>.
</p>
<p>
Regardless of <em class="parameter"><code>policy</code></em>, the stream's final position will be clamped
to the range specified by its lower and upper bounds, and the
stream's eos state will be updated.</p>
<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</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td> offset value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
<td> what to do with the offset
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> new position, <code class="literal">-1</code> if operation failed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_seekable_stream_tell ()">
<a name="camel-seekable-stream-tell"></a><h3>camel_seekable_stream_tell ()</h3>
<pre class="programlisting">off_t camel_seekable_stream_tell (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream);</pre>
<p>
Get the current position of a seekable stream.</p>
<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</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the current position of the stream.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_seekable_stream_set_bounds ()">
<a name="camel-seekable-stream-set-bounds"></a><h3>camel_seekable_stream_set_bounds ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_seekable_stream_set_bounds (<a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream">CamelSeekableStream</a> *stream,
off_t start,
off_t end);</pre>
<p>
Set the range of valid data this stream is allowed to cover. If
there is to be no <em class="parameter"><code>end</code></em> value, then <em class="parameter"><code>end</code></em> should be set to
<a class="link" href="camel-CamelSeekableStream.html#CAMEL-STREAM-UNBOUND--CAPS" title="CAMEL_STREAM_UNBOUND"><span class="type">CAMEL_STREAM_UNBOUND</span></a>.</p>
<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</code></em> :</span></p></td>
<td> a <a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start</code></em> :</span></p></td>
<td> the first valid position
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td> the first invalid position, or <a class="link" href="camel-CamelSeekableStream.html#CAMEL-STREAM-UNBOUND--CAPS" title="CAMEL_STREAM_UNBOUND"><span class="type">CAMEL_STREAM_UNBOUND</span></a>
</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.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>