2 tio.h - timed io functions
3 This file is part of the nss-pam-ldapd library.
5 Copyright (C) 2007, 2008, 2010, 2012 Arthur de Jong
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or (at your option) any later version.
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
25 TODO: Add some documentation here.
27 the SIGPIPE signal should be ignored (is ignored in this code)
29 This library is not thread safe. You cannot share TFILE objects between
30 threads and expect to be able to read and write from them in different
31 threads. All the state is in the TFILE object so calls to this library on
32 different objects can be done in parallel.
40 #include <sys/types.h>
44 /* This is a generic file handle used for reading and writing
45 (something like FILE from stdio.h). */
46 typedef struct tio_fileinfo TFILE;
48 /* Open a new TFILE based on the file descriptor. The timeout is set for any
49 operation (value in milliseconds). */
50 TFILE *tio_fdopen(int fd,int readtimeout,int writetimeout,
51 size_t initreadsize,size_t maxreadsize,
52 size_t initwritesize,size_t maxwritesize)
55 /* Read the specified number of bytes from the stream. */
56 int tio_read(TFILE *fp,void *buf,size_t count);
58 /* Read and discard the specified number of bytes from the stream. */
59 int tio_skip(TFILE *fp,size_t count);
61 /* Read all available data from the stream and empty the read buffer. */
62 int tio_skipall(TFILE *fp);
64 /* Write the specified buffer to the stream. */
65 int tio_write(TFILE *fp,const void *buf,size_t count);
67 /* Write out all buffered data to the stream. */
68 int tio_flush(TFILE *fp);
70 /* Flush the streams and closes the underlying file descriptor. */
71 int tio_close(TFILE *fp);
73 /* Store the current position in the stream so that we can jump back to it
74 with the tio_reset() function. */
75 void tio_mark(TFILE *fp);
77 /* Rewinds the stream to the point set by tio_mark(). Note that this only
78 resets the read stream and not the write stream. This function returns
79 whether the reset was successful (this function may fail if the buffers
81 int tio_reset(TFILE *fp);
83 #endif /* COMMON__TIO_H */