1#ifndef fooiochannelhfoo
2#define fooiochannelhfoo
3
4/***
5  This file is part of PulseAudio.
6
7  Copyright 2004-2006 Lennart Poettering
8  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10  PulseAudio is free software; you can redistribute it and/or modify
11  it under the terms of the GNU Lesser General Public License as
12  published by the Free Software Foundation; either version 2.1 of the
13  License, or (at your option) any later version.
14
15  PulseAudio is distributed in the hope that it will be useful, but
16  WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  Lesser General Public License for more details.
19
20  You should have received a copy of the GNU Lesser General Public
21  License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22***/
23
24#ifndef PACKAGE
25#error "Please include config.h before including this file!"
26#endif
27
28#include <sys/types.h>
29
30#include <pulse/mainloop-api.h>
31#include <pulsecore/creds.h>
32#include <pulsecore/macro.h>
33
34/* A wrapper around UNIX file descriptors for attaching them to the a
35   main event loop. Every time new data may be read or be written to
36   the channel a callback function is called. It is safe to destroy
37   the calling iochannel object from the callback */
38
39typedef struct pa_iochannel pa_iochannel;
40
41/* Create a new IO channel for the specified file descriptors for
42input resp. output. It is safe to pass the same file descriptor for
43both parameters (in case of full-duplex channels). For a simplex
44channel specify -1 for the other direction. */
45
46pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
47void pa_iochannel_free(pa_iochannel*io);
48
49/* Returns: length written on success, 0 if a retry is needed, negative value
50 * on error. */
51ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
52ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);
53
54#ifdef HAVE_CREDS
55bool pa_iochannel_creds_supported(pa_iochannel *io);
56int pa_iochannel_creds_enable(pa_iochannel *io);
57
58ssize_t pa_iochannel_write_with_fds(pa_iochannel*io, const void*data, size_t l, int nfd, const int *fds);
59ssize_t pa_iochannel_write_with_creds(pa_iochannel*io, const void*data, size_t l, const pa_creds *ucred);
60ssize_t pa_iochannel_read_with_ancil_data(pa_iochannel*io, void*data, size_t l, pa_cmsg_ancil_data *ancil_data);
61#endif
62
63bool pa_iochannel_is_readable(pa_iochannel*io);
64bool pa_iochannel_is_writable(pa_iochannel*io);
65bool pa_iochannel_is_hungup(pa_iochannel*io);
66
67/* Don't close the file descriptors when the io channel is freed. By
68 * default the file descriptors are closed. */
69void pa_iochannel_set_noclose(pa_iochannel*io, bool b);
70
71/* Set the callback function that is called whenever data becomes available for read or write */
72typedef void (*pa_iochannel_cb_t)(pa_iochannel*io, void *userdata);
73void pa_iochannel_set_callback(pa_iochannel*io, pa_iochannel_cb_t callback, void *userdata);
74
75/* In case the file descriptor is a socket, return a pretty-printed string in *s which describes the peer connected */
76void pa_iochannel_socket_peer_to_string(pa_iochannel*io, char*s, size_t l);
77
78/* Use setsockopt() to tune the receive and send buffers of TCP sockets */
79int pa_iochannel_socket_set_rcvbuf(pa_iochannel*io, size_t l);
80int pa_iochannel_socket_set_sndbuf(pa_iochannel*io, size_t l);
81
82bool pa_iochannel_socket_is_local(pa_iochannel *io);
83
84pa_mainloop_api* pa_iochannel_get_mainloop_api(pa_iochannel *io);
85
86int pa_iochannel_get_recv_fd(pa_iochannel *io);
87int pa_iochannel_get_send_fd(pa_iochannel *io);
88
89#endif
90