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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libprelude-prelude-io">
<refmeta>
<refentrytitle id="top_of_page">prelude-io</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBPRELUDE Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prelude-io</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="prelude-io-t">prelude_io_t</link>;
<link linkend="int">int</link> <link linkend="prelude-io-new">prelude_io_new</link> (<link linkend="prelude-io-t">prelude_io_t</link> **ret);
<link linkend="void">void</link> <link linkend="prelude-io-destroy">prelude_io_destroy</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="void">void</link> <link linkend="prelude-io-set-file-io">prelude_io_set_file_io</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="FILE:CAPS">FILE</link> *fd);
<link linkend="void">void</link> <link linkend="prelude-io-set-tls-io">prelude_io_set_tls_io</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *tls);
<link linkend="void">void</link> <link linkend="prelude-io-set-sys-io">prelude_io_set_sys_io</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="int">int</link> fd);
<link linkend="int">int</link> <link linkend="prelude-io-set-buffer-io">prelude_io_set_buffer_io</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="int">int</link> <link linkend="prelude-io-close">prelude_io_close</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-read">prelude_io_read</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-read-wait">prelude_io_read_wait</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-read-delimited">prelude_io_read_delimited</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
unsigned <link linkend="char">char</link> **buf);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-write">prelude_io_write</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
const <link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-write-delimited">prelude_io_write_delimited</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
const <link linkend="void">void</link> *buf,
<link linkend="uint16-t">uint16_t</link> count);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-forward">prelude_io_forward</link> (<link linkend="prelude-io-t">prelude_io_t</link> *dst,
<link linkend="prelude-io-t">prelude_io_t</link> *src,
<link linkend="size-t">size_t</link> count);
<link linkend="int">int</link> <link linkend="prelude-io-get-fd">prelude_io_get_fd</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="void">void</link>* <link linkend="prelude-io-get-fdptr">prelude_io_get_fdptr</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="ssize-t">ssize_t</link> <link linkend="prelude-io-pending">prelude_io_pending</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio);
<link linkend="prelude-bool-t">prelude_bool_t</link> <link linkend="prelude-io-is-error-fatal">prelude_io_is_error_fatal</link> (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="int">int</link> error);
</synopsis>
</refsynopsisdiv>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="prelude-io-t" role="typedef"/>prelude_io_t</title>
<indexterm><primary>prelude_io_t</primary></indexterm><programlisting>typedef struct prelude_io prelude_io_t;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="prelude-io-new" role="function"/>prelude_io_new ()</title>
<indexterm><primary>prelude_io_new</primary></indexterm><programlisting><link linkend="int">int</link> prelude_io_new (<link linkend="prelude-io-t">prelude_io_t</link> **ret);</programlisting>
<para>
Create a new prelude IO object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ret</parameter> :</term>
<listitem><simpara> Pointer where to store the created <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> 0 on success, or a negative value if an error occur.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-destroy" role="function"/>prelude_io_destroy ()</title>
<indexterm><primary>prelude_io_destroy</primary></indexterm><programlisting><link linkend="void">void</link> prelude_io_destroy (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
Destroy the <parameter>pio</parameter> object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-set-file-io" role="function"/>prelude_io_set_file_io ()</title>
<indexterm><primary>prelude_io_set_file_io</primary></indexterm><programlisting><link linkend="void">void</link> prelude_io_set_file_io (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="FILE:CAPS">FILE</link> *fd);</programlisting>
<para>
Setup the <parameter>pio</parameter> object to work with file I/O function.
The <parameter>pio</parameter> object is then associated with <parameter>fd</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> A pointer on the <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fd</parameter> :</term>
<listitem><simpara> File descriptor identifying a file.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-set-tls-io" role="function"/>prelude_io_set_tls_io ()</title>
<indexterm><primary>prelude_io_set_tls_io</primary></indexterm><programlisting><link linkend="void">void</link> prelude_io_set_tls_io (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *tls);</programlisting>
<para>
Setup the <parameter>pio</parameter> object to work with TLS based I/O function.
The <parameter>pio</parameter> object is then associated with <parameter>tls</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> A pointer on the <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tls</parameter> :</term>
<listitem><simpara> Pointer on the TLS structure holding the TLS connection data.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-set-sys-io" role="function"/>prelude_io_set_sys_io ()</title>
<indexterm><primary>prelude_io_set_sys_io</primary></indexterm><programlisting><link linkend="void">void</link> prelude_io_set_sys_io (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="int">int</link> fd);</programlisting>
<para>
Setup the <parameter>pio</parameter> object to work with system based I/O function.
The <parameter>pio</parameter> object is then associated with <parameter>fd</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> A pointer on the <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fd</parameter> :</term>
<listitem><simpara> A file descriptor.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-set-buffer-io" role="function"/>prelude_io_set_buffer_io ()</title>
<indexterm><primary>prelude_io_set_buffer_io</primary></indexterm><programlisting><link linkend="int">int</link> prelude_io_set_buffer_io (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-close" role="function"/>prelude_io_close ()</title>
<indexterm><primary>prelude_io_close</primary></indexterm><programlisting><link linkend="int">int</link> prelude_io_close (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
<link linkend="prelude-io-close"><function>prelude_io_close()</function></link> closes the file descriptor indentified by <parameter>pio</parameter>,
</para>
<para>
The case where the <link linkend="close"><function>close()</function></link> function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.
</para>
<para>
However, and especially when the underlaying layer is TLS, <link linkend="prelude-io-close"><function>prelude_io_close()</function></link>
might return error. If this happen, you should continue calling the function
until it return zero.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> zero on success, or -1 if an error occurred.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-read" role="function"/>prelude_io_read ()</title>
<indexterm><primary>prelude_io_read</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_read (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);</programlisting>
<para>
<link linkend="prelude-io-read"><function>prelude_io_read()</function></link> attempts to read up to <parameter>count</parameter> bytes from the
file descriptor identified by <parameter>pio</parameter> into the buffer starting at <parameter>buf</parameter>.
</para>
<para>
If <parameter>count</parameter> is zero, <link linkend="prelude-io-read"><function>prelude_io_read()</function></link> returns zero and has no other
results. If <parameter>count</parameter> is greater than SSIZE_MAX, the result is unspecified.
</para>
<para>
The case where the read function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to the buffer to store data into.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Number of bytes to read.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> On success, the number of bytes read is returned (zero
indicates end of file). It is not an error if this number is smaller
than the number of bytes requested; this may happen for example because
fewer bytes are actually available right now or because <link linkend="read"><function>read()</function></link> was
interrupted by a signal.
On error, a negative value is returned. In this case it is left unspecified
whether the file position (if any) changes.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-read-wait" role="function"/>prelude_io_read_wait ()</title>
<indexterm><primary>prelude_io_read_wait</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_read_wait (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);</programlisting>
<para>
<link linkend="prelude-io-read-wait"><function>prelude_io_read_wait()</function></link> attempts to read up to <parameter>count</parameter> bytes from the
file descriptor identified by <parameter>pio</parameter> into the buffer starting at <parameter>buf</parameter>.
</para>
<para>
If <parameter>count</parameter> is zero, <link linkend="prelude-io-read"><function>prelude_io_read()</function></link> returns zero and has no other
results. If <parameter>count</parameter> is greater than SSIZE_MAX, the result is unspecified.
</para>
<para>
The case where the read function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.
</para>
<para>
<link linkend="prelude-io-read-wait"><function>prelude_io_read_wait()</function></link> always return the number of bytes requested.
Be carefull that this function is blocking.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to the buffer to store data into.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Number of bytes to read.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> On success, the number of bytes read is returned (zero
indicates end of file).
On error, -1 is returned, and errno is set appropriately. In this
case it is left unspecified whether the file position (if any) changes.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-read-delimited" role="function"/>prelude_io_read_delimited ()</title>
<indexterm><primary>prelude_io_read_delimited</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_read_delimited (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
unsigned <link linkend="char">char</link> **buf);</programlisting>
<para>
<link linkend="prelude-io-read-delimited"><function>prelude_io_read_delimited()</function></link> read message written by <link linkend="prelude-write-delimited"><function>prelude_write_delimited()</function></link>.
Theses messages are sents along with the len of the message.
</para>
<para>
Uppon return the <parameter>buf</parameter> argument is updated to point on a newly allocated
buffer containing the data read. The <parameter>count</parameter> argument is set to the number of
bytes the message was containing.
</para>
<para>
The case where the read function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to the address of a buffer to store address of data into.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> On success, the number of bytes read is returned (zero
indicates end of file).
On error, -1 is returned, and errno is set appropriately. In this
case it is left unspecified whether the file position (if any) changes.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-write" role="function"/>prelude_io_write ()</title>
<indexterm><primary>prelude_io_write</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_write (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
const <link linkend="void">void</link> *buf,
<link linkend="size-t">size_t</link> count);</programlisting>
<para>
<link linkend="prelude-io-write"><function>prelude_io_write()</function></link> writes up to <parameter>count</parameter> bytes to the file descriptor
identified by <parameter>pio</parameter> from the buffer starting at <parameter>buf</parameter>. POSIX requires
that a <link linkend="read"><function>read()</function></link> which can be proved to occur after a <link linkend="write"><function>write()</function></link> has returned
returns the new data. Note that not all file systems are POSIX conforming.
</para>
<para>
The case where the <link linkend="write"><function>write()</function></link> function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to the buffer to write data from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Number of bytes to write.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> On success, the number of bytes written are returned (zero
indicates nothing was written). On error, -1 is returned, and errno
is set appropriately. If <parameter>count</parameter> is zero and the file descriptor refers
to a regular file, 0 will be returned without causing any other effect.
For a special file, the results are not portable.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-write-delimited" role="function"/>prelude_io_write_delimited ()</title>
<indexterm><primary>prelude_io_write_delimited</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_write_delimited (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
const <link linkend="void">void</link> *buf,
<link linkend="uint16-t">uint16_t</link> count);</programlisting>
<para>
<link linkend="prelude-io-write-delimited"><function>prelude_io_write_delimited()</function></link> writes up to <parameter>count</parameter> bytes to the file descriptor
identified by <parameter>pio</parameter> from the buffer starting at <parameter>buf</parameter>. POSIX requires
that a <link linkend="read"><function>read()</function></link> which can be proved to occur after a <link linkend="write"><function>write()</function></link> has returned
returns the new data. Note that not all file systems are POSIX conforming.
</para>
<para>
<link linkend="prelude-io-write-delimited"><function>prelude_io_write_delimited()</function></link> also write the len of the data to be sent.
which allow <link linkend="prelude-io-read-delimited"><function>prelude_io_read_delimited()</function></link> to safely know if it got all the
data a given write contain.
</para>
<para>
The case where the <link linkend="write"><function>write()</function></link> function would be interrupted by a signal is
handled internally. So you don't have to check for EINTR.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buf</parameter> :</term>
<listitem><simpara> Pointer to the buffer to write data from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Number of bytes to write.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> On success, the number of bytes written are returned (zero
indicates nothing was written). On error, -1 is returned, and errno
is set appropriately.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-forward" role="function"/>prelude_io_forward ()</title>
<indexterm><primary>prelude_io_forward</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_forward (<link linkend="prelude-io-t">prelude_io_t</link> *dst,
<link linkend="prelude-io-t">prelude_io_t</link> *src,
<link linkend="size-t">size_t</link> count);</programlisting>
<para>
<link linkend="prelude-io-forward"><function>prelude_io_forward()</function></link> attempts to transfer up to <parameter>count</parameter> bytes from
the file descriptor identified by <parameter>src</parameter> into the file descriptor
identified by <parameter>dst</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dst</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>src</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>count</parameter> :</term>
<listitem><simpara> Number of byte to forward from <parameter>src</parameter> to <parameter>dst</parameter>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> If the transfer was successful, the number of bytes written
to <parameter>dst</parameter> is returned. On error, -1 is returned, and errno is set appropriately.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-get-fd" role="function"/>prelude_io_get_fd ()</title>
<indexterm><primary>prelude_io_get_fd</primary></indexterm><programlisting><link linkend="int">int</link> prelude_io_get_fd (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> A pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The FD associated with this object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-get-fdptr" role="function"/>prelude_io_get_fdptr ()</title>
<indexterm><primary>prelude_io_get_fdptr</primary></indexterm><programlisting><link linkend="void">void</link>* prelude_io_get_fdptr (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> A pointer on a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer associated with this object (file, tls, buffer, or NULL).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-pending" role="function"/>prelude_io_pending ()</title>
<indexterm><primary>prelude_io_pending</primary></indexterm><programlisting><link linkend="ssize-t">ssize_t</link> prelude_io_pending (<link linkend="prelude-io-t">prelude_io_t</link> *pio);</programlisting>
<para>
prelude_io_pending return the number of bytes waiting to
be read on an TLS or socket fd.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Number of byte waiting to be read on <parameter>pio</parameter>, or -1
if <parameter>pio</parameter> is not of type TLS or socket.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="prelude-io-is-error-fatal" role="function"/>prelude_io_is_error_fatal ()</title>
<indexterm><primary>prelude_io_is_error_fatal</primary></indexterm><programlisting><link linkend="prelude-bool-t">prelude_bool_t</link> prelude_io_is_error_fatal (<link linkend="prelude-io-t">prelude_io_t</link> *pio,
<link linkend="int">int</link> error);</programlisting>
<para>
Check whether the returned error is fatal, or not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pio</parameter> :</term>
<listitem><simpara> Pointer to a <link linkend="prelude-io-t"><type>prelude_io_t</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> Error returned by one of the <link linkend="prelude-io-t"><type>prelude_io_t</type></link> function.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if error is fatal, FALSE if it is not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
