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
|
<!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.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="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>
<span class="returnvalue">off_t</span> <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-seek" title="camel_seekable_stream_seek ()">camel_seekable_stream_seek</a> (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">off_t</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelStreamSeekPolicy" title="enum CamelStreamSeekPolicy"><span class="type">CamelStreamSeekPolicy</span></a> policy</code></em>);
<span class="returnvalue">off_t</span> <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-tell" title="camel_seekable_stream_tell ()">camel_seekable_stream_tell</a> (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-CamelSeekableStream.html#camel-seekable-stream-set-bounds" title="camel_seekable_stream_set_bounds ()">camel_seekable_stream_set_bounds</a> (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">off_t</span> start</code></em>,
<em class="parameter"><code><span class="type">off_t</span> end</code></em>);
</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"><span class="returnvalue">off_t</span> camel_seekable_stream_seek (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">off_t</span> offset</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelStreamSeekPolicy" title="enum CamelStreamSeekPolicy"><span class="type">CamelStreamSeekPolicy</span></a> policy</code></em>);</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>
<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"><span class="returnvalue">off_t</span> camel_seekable_stream_tell (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>);</pre>
<p>
Get the current position of a seekable 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="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"><span class="returnvalue">gint</span> camel_seekable_stream_set_bounds (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *stream</code></em>,
<em class="parameter"><code><span class="type">off_t</span> start</code></em>,
<em class="parameter"><code><span class="type">off_t</span> end</code></em>);</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>
<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.14</div>
</body>
</html>
|
