evolution-data-server-doc 3.28.1-1ubuntu1 / usr / share / gtk-doc / html / camel / camel-CamelStreamBuffer.html

This file is indexed.

/usr/share/gtk-doc/html/camel/camel-CamelStreamBuffer.html is in evolution-data-server-doc 3.28.1-1ubuntu1.

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
<!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: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<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-CamelStreamFilter.html" title="CamelStreamFilter">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#camel-CamelStreamBuffer.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Streams.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-CamelStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-CamelStreamFilter.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-CamelStreamBuffer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">CamelStream</span> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-new" title="camel_stream_buffer_new ()">camel_stream_buffer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-gets" title="camel_stream_buffer_gets ()">camel_stream_buffer_gets</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelStreamBuffer.html#camel-stream-buffer-read-line" title="camel_stream_buffer_read_line ()">camel_stream_buffer_read_line</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelStreamBuffer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="camel-CamelStreamBuffer.html#CamelStreamBufferMode" title="enum CamelStreamBufferMode">CamelStreamBufferMode</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelStreamBuffer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelStreamBuffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-stream-buffer-new"></a><h3>camel_stream_buffer_new ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelStream</span> *
camel_stream_buffer_new (<em class="parameter"><code><span class="type">CamelStream</span> *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>The following values are available for <em class="parameter"><code>mode</code></em>
:</p>
<p><a class="link" href="camel-CamelStreamBuffer.html#CAMEL-STREAM-BUFFER-BUFFER:CAPS"><span class="type">CAMEL_STREAM_BUFFER_BUFFER</span></a>, Buffer the input/output in blocks.
<span class="type">CAMEL_STREAM_BUFFER_NEWLINE</span>, Buffer on newlines (for output).
<a class="link" href="camel-CamelStreamBuffer.html#CAMEL-STREAM-BUFFER-NONE:CAPS"><span class="type">CAMEL_STREAM_BUFFER_NONE</span></a>, Perform no buffering.</p>
<p>Note that currently this is ignored and <a class="link" href="camel-CamelStreamBuffer.html#CAMEL-STREAM-BUFFER-BUFFER:CAPS"><span class="type">CAMEL_STREAM_BUFFER_BUFFER</span></a>
is always used.</p>
<p>In addition, one of the following mode options should be or'd
together with the buffering mode:</p>
<p><a class="link" href="camel-CamelStreamBuffer.html#CAMEL-STREAM-BUFFER-WRITE:CAPS"><span class="type">CAMEL_STREAM_BUFFER_WRITE</span></a>, Buffer in write mode.
<a class="link" href="camel-CamelStreamBuffer.html#CAMEL-STREAM-BUFFER-READ:CAPS"><span class="type">CAMEL_STREAM_BUFFER_READ</span></a>, Buffer in read mode.</p>
<p>Buffering can only be done in one direction for any
buffer instance.</p>
<div class="refsect3">
<a name="camel-stream-buffer-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <span class="type">CamelStream</span> object to buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>Operational mode of buffered stream.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-stream-buffer-new.returns"></a><h4>Returns</h4>
<p> a newly created buffered stream.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-buffer-gets"></a><h3>camel_stream_buffer_gets ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
camel_stream_buffer_gets (<em class="parameter"><code><span class="type">CamelStreamBuffer</span> *sbf</code></em>,
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buf</code></em>,
                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max</code></em>,
                          <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</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 <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> terminated.</p>
<div class="refsect3">
<a name="camel-stream-buffer-gets.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sbf</p></td>
<td class="parameter_description"><p>a <span class="type">CamelStreamBuffer</span> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buf</p></td>
<td class="parameter_description"><p>Memory to write the string to. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=max][<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> gchar]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>Maxmimum number of characters to store.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-stream-buffer-gets.returns"></a><h4>Returns</h4>
<p> the number of characters read, or 0 for end of file,
and -1 on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-stream-buffer-read-line"></a><h3>camel_stream_buffer_read_line ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
camel_stream_buffer_read_line (<em class="parameter"><code><span class="type">CamelStreamBuffer</span> *sbf</code></em>,
                               <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                               <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This function reads a complete newline-terminated line from the stream
and returns it in allocated memory. The trailing newline (and carriage
return if any) are not included in the returned string.</p>
<div class="refsect3">
<a name="camel-stream-buffer-read-line.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sbf</p></td>
<td class="parameter_description"><p>a <span class="type">CamelStreamBuffer</span> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <em class="parameter"><code>GError</code></em>
, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-stream-buffer-read-line.returns"></a><h4>Returns</h4>
<p>the line read, which the caller must free when done with,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on eof. If an error occurs, <em class="parameter"><code>error</code></em>
will be set. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="camel-CamelStreamBuffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CamelStreamBufferMode"></a><h3>enum CamelStreamBufferMode</h3>
<div class="refsect3">
<a name="CamelStreamBufferMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-STREAM-BUFFER-BUFFER:CAPS"></a>CAMEL_STREAM_BUFFER_BUFFER</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-STREAM-BUFFER-NONE:CAPS"></a>CAMEL_STREAM_BUFFER_NONE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-STREAM-BUFFER-READ:CAPS"></a>CAMEL_STREAM_BUFFER_READ</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-STREAM-BUFFER-WRITE:CAPS"></a>CAMEL_STREAM_BUFFER_WRITE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-STREAM-BUFFER-MODE:CAPS"></a>CAMEL_STREAM_BUFFER_MODE</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.