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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelStreamBuffer</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-CamelSeekableSubstream.html" title="CamelSeekableSubstream">
<link rel="next" href="camel-CamelStreamFilter.html" title="CamelStreamFilter">
<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-CamelSeekableSubstream.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-CamelStreamFilter.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-CamelStreamBuffer.synopsis" class="shortcut">Top</a>
|
<a href="#camel-CamelStreamBuffer.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="CamelStreamBuffer">
<a name="camel-CamelStreamBuffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelStreamBuffer.top_of_page"></a>CamelStreamBuffer</span></h2>
<p>CamelStreamBuffer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-CamelStreamBuffer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer">CamelStreamBuffer</a>;
enum <a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode">CamelStreamBufferMode</a>;
<a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-new" title="camel_stream_buffer_new ()">camel_stream_buffer_new</a> (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode"><span class="type">CamelStreamBufferMode</span></a> mode</code></em>);
<a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> * <a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-new-with-vbuf" title="camel_stream_buffer_new_with_vbuf ()">camel_stream_buffer_new_with_vbuf</a> (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode"><span class="type">CamelStreamBufferMode</span></a> mode</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buf</code></em>,
<em class="parameter"><code><span class="type">guint32</span> size</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-gets" title="camel_stream_buffer_gets ()">camel_stream_buffer_gets</a> (<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer"><span class="type">CamelStreamBuffer</span></a> *sbf</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buf</code></em>,
<em class="parameter"><code><span class="type">guint</span> max</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-read-line" title="camel_stream_buffer_read_line ()">camel_stream_buffer_read_line</a> (<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer"><span class="type">CamelStreamBuffer</span></a> *sbf</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-CamelStreamBuffer.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-CamelStreamBuffer.details"></a><h2>Details</h2>
<div class="refsect2" title="struct CamelStreamBuffer">
<a name="CamelStreamBuffer"></a><h3>struct CamelStreamBuffer</h3>
<pre class="programlisting">struct CamelStreamBuffer {
CamelStream parent_object;
/* these are all of course, private */
CamelStream *stream;
guchar *buf, *ptr, *end;
gint size;
guchar *linebuf; /* for reading lines at a time */
gint linesize;
CamelStreamBufferMode mode;
guint flags; /* internal flags */
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="enum CamelStreamBufferMode">
<a name="CamelStreamBufferMode"></a><h3>enum CamelStreamBufferMode</h3>
<pre class="programlisting">typedef enum {
CAMEL_STREAM_BUFFER_BUFFER = 0,
CAMEL_STREAM_BUFFER_NONE,
CAMEL_STREAM_BUFFER_READ = 0x00,
CAMEL_STREAM_BUFFER_WRITE = 0x80,
CAMEL_STREAM_BUFFER_MODE = 0x80
} CamelStreamBufferMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_stream_buffer_new ()">
<a name="camel-stream-buffer-new"></a><h3>camel_stream_buffer_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_stream_buffer_new (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode"><span class="type">CamelStreamBufferMode</span></a> mode</code></em>);</pre>
<p>
Create a new buffered stream of another stream. A default
buffer size (1024 bytes), automatically managed will be used
for buffering.
</p>
<p>
See <a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-new-with-vbuf" title="camel_stream_buffer_new_with_vbuf ()"><span class="type">camel_stream_buffer_new_with_vbuf</span></a> for details on the
<em class="parameter"><code>mode</code></em> parameter.
</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 to buffer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>Operational mode of buffered stream.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly created buffered stream.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_stream_buffer_new_with_vbuf ()">
<a name="camel-stream-buffer-new-with-vbuf"></a><h3>camel_stream_buffer_new_with_vbuf ()</h3>
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> * camel_stream_buffer_new_with_vbuf (<em class="parameter"><code><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="type">CamelStream</span></a> *stream</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode"><span class="type">CamelStreamBufferMode</span></a> mode</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buf</code></em>,
<em class="parameter"><code><span class="type">guint32</span> size</code></em>);</pre>
<p>
Create a new stream which buffers another stream, <em class="parameter"><code>stream</code></em>.
</p>
<p>
The following values are available for <em class="parameter"><code>mode</code></em>:
</p>
<p>
<span class="type">CAMEL_STREAM_BUFFER_BUFFER</span>, Buffer the input/output in blocks.
<span class="type">CAMEL_STREAM_BUFFER_NEWLINE</span>, Buffer on newlines (for output).
<span class="type">CAMEL_STREAM_BUFFER_NONE</span>, Perform no buffering.
</p>
<p>
Note that currently this is ignored and <span class="type">CAMEL_STREAM_BUFFER_BUFFER</span>
is always used.
</p>
<p>
In addition, one of the following mode options should be or'd
together with the buffering mode:
</p>
<p>
<span class="type">CAMEL_STREAM_BUFFER_WRITE</span>, Buffer in write mode.
<span class="type">CAMEL_STREAM_BUFFER_READ</span>, Buffer in read mode.
</p>
<p>
Buffering can only be done in one direction for any
buffer instance.
</p>
<p>
If <em class="parameter"><code>buf</code></em> is non-NULL, then use the memory pointed to
(for upto <em class="parameter"><code>size</code></em> bytes) as the buffer for all buffering
operations. It is upto the application to free this buffer.
If <em class="parameter"><code>buf</code></em> is NULL, then allocate and manage <em class="parameter"><code>size</code></em> bytes
for all buffering.
</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>An existing stream to buffer.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>Mode to buffer in.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
<td>Memory to use for buffering.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>Size of buffer to use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new stream with buffering applied.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_stream_buffer_gets ()">
<a name="camel-stream-buffer-gets"></a><h3>camel_stream_buffer_gets ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_stream_buffer_gets (<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer"><span class="type">CamelStreamBuffer</span></a> *sbf</code></em>,
<em class="parameter"><code><span class="type">gchar</span> *buf</code></em>,
<em class="parameter"><code><span class="type">guint</span> max</code></em>);</pre>
<p>
Read a line of characters up to the next newline character or
<em class="parameter"><code>max</code></em>-1 characters.
</p>
<p>
If the newline character is encountered, then it will be
included in the buffer <em class="parameter"><code>buf</code></em>. The buffer will be <span class="type">NUL</span> terminated.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sbf</code></em> :</span></p></td>
<td>a <a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer"><span class="type">CamelStreamBuffer</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
<td>Memory to write the string to.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>Maxmimum number of characters to store.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the number of characters read, or <code class="literal">0</code> for end of file,
and <code class="literal">-1</code> on error.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_stream_buffer_read_line ()">
<a name="camel-stream-buffer-read-line"></a><h3>camel_stream_buffer_read_line ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_stream_buffer_read_line (<em class="parameter"><code><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBuffer" title="struct CamelStreamBuffer"><span class="type">CamelStreamBuffer</span></a> *sbf</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sbf</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
