doc: Move filter examples to man page.
[paraslash.git] / fd.h
1 /* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
2
3 /** \file fd.h exported symbols from fd.c */
4
5 int xrename(const char *oldpath, const char *newpath);
6 int write_all(int fd, const char *buf, size_t len);
7 __printf_2_3 int write_va_buffer(int fd, const char *fmt, ...);
8 bool file_exists(const char *);
9 int para_select(int n, fd_set *readfds, fd_set *writefds,
10                 struct timeval *timeout_tv);
11 __must_check int mark_fd_nonblocking(int fd);
12 __must_check int mark_fd_blocking(int fd);
13 void para_fd_set(int fd, fd_set *fds, int *max_fileno);
14 __must_check int para_fgets(char *line, int size, FILE *f);
15 int para_mmap(size_t length, int prot, int flags, int fd, off_t offset,
16                 void *map);
17 int para_open(const char *path, int flags, mode_t mode);
18 int para_mkdir(const char *path, mode_t mode);
19 int para_chdir(const char *path);
20 int mmap_full_file(const char *filename, int open_mode, void **map,
21         size_t *size, int *fd_ptr);
22 int para_munmap(void *start, size_t length);
23 int write_ok(int fd);
24 void valid_fd_012(void);
25 int readv_nonblock(int fd, struct iovec *iov, int iovcnt, fd_set *rfds,
26                 size_t *num_bytes);
27 int read_nonblock(int fd, void *buf, size_t sz, fd_set *rfds, size_t *num_bytes);
28 int read_pattern(int fd, const char *pattern, size_t bufsize, fd_set *rfds);
29 int xwrite(int fd, const char *buf, size_t len);
30 int xwritev(int fd, struct iovec *iov, int iovcnt);
31 int for_each_file_in_dir(const char *dirname,
32                 int (*func)(const char *, void *), void *private_data);
33 /**
34  * Write a \p NULL-terminated buffer.
35  *
36  * \param fd The file descriptor.
37  * \param buf The null-terminated buffer to be send.
38  *
39  * This is equivalent to write_all(fd, buf, strlen(buf)).
40  *
41  * \return Standard.
42  */
43 _static_inline_ int write_buffer(int fd, const char *buf)
44 {
45         return write_all(fd, buf, strlen(buf));
46 }