File: camel-CamelSeekableSubstream.html

package info (click to toggle)
evolution-data-server 2.30.3-2%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 45,704 kB
  • ctags: 26,968
  • sloc: ansic: 223,692; sh: 10,413; makefile: 2,646; xml: 386; perl: 204; python: 30
file content (114 lines) | stat: -rw-r--r-- 6,311 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelSeekableSubstream</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-CamelSeekableStream.html" title="CamelSeekableStream">
<link rel="next" href="camel-CamelStreamBuffer.html" title="CamelStreamBuffer">
<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-CamelSeekableStream.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-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="#camel-CamelSeekableSubstream.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#camel-CamelSeekableSubstream.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelSeekableSubstream">
<a name="camel-CamelSeekableSubstream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelSeekableSubstream.top_of_page"></a>CamelSeekableSubstream</span></h2>
<p>CamelSeekableSubstream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelSeekableSubstream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="camel-CamelSeekableSubstream.html#CamelSeekableSubstream" title="struct CamelSeekableSubstream">CamelSeekableSubstream</a>;
<a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       <a class="link" href="camel-CamelSeekableSubstream.html#camel-seekable-substream-new" title="camel_seekable_substream_new ()">camel_seekable_substream_new</a>        (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *parent_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-CamelSeekableSubstream.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelSeekableSubstream.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelSeekableSubstream">
<a name="CamelSeekableSubstream"></a><h3>struct CamelSeekableSubstream</h3>
<pre class="programlisting">struct CamelSeekableSubstream {
	CamelSeekableStream parent_object;

	/*  --**-- Private fields --**--  */
	CamelSeekableStream *parent_stream;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_seekable_substream_new ()">
<a name="camel-seekable-substream-new"></a><h3>camel_seekable_substream_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_seekable_substream_new        (<em class="parameter"><code><a class="link" href="camel-CamelSeekableStream.html#CamelSeekableStream" title="struct CamelSeekableStream"><span class="type">CamelSeekableStream</span></a> *parent_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>
Creates a new CamelSeekableSubstream that references the portion
of <em class="parameter"><code>parent_stream</code></em> from <em class="parameter"><code>inf_bound</code></em> to <em class="parameter"><code>sup_bound</code></em>. (If <em class="parameter"><code>sup_bound</code></em> is
<a class="link" href="camel-CamelSeekableStream.html#CAMEL-STREAM-UNBOUND:CAPS" title="CAMEL_STREAM_UNBOUND"><span class="type">CAMEL_STREAM_UNBOUND</span></a>, it references to the end of stream, even if
the stream grows.)
</p>
<p>
While the substream is open, the caller cannot assume anything about
the current position of <em class="parameter"><code>parent_stream</code></em>. After the substream has been
closed, <em class="parameter"><code>parent_stream</code></em> will stabilize again.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent_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>a lower bound
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end</code></em> :</span></p></td>
<td>an upper bound
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the substream
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>