]> code.delx.au - pulseaudio/blob - src/polypcore/iochannel.h
7d355d8f0e059b19ec28d558eda2e3af48fb17bd
[pulseaudio] / src / polypcore / iochannel.h
1 #ifndef fooiochannelhfoo
2 #define fooiochannelhfoo
3
4 /* $Id$ */
5
6 /***
7 This file is part of polypaudio.
8
9 polypaudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as
11 published by the Free Software Foundation; either version 2.1 of the
12 License, or (at your option) any later version.
13
14 polypaudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
18
19 You should have received a copy of the GNU Lesser General Public
20 License along with polypaudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22 USA.
23 ***/
24
25 #include <sys/types.h>
26 #include <polyp/mainloop-api.h>
27
28 /* A wrapper around UNIX file descriptors for attaching them to the a
29 main event loop. Everytime new data may be read or be written to
30 the channel a callback function is called. It is safe to destroy
31 the calling iochannel object from the callback */
32
33 /* When pa_iochannel_is_readable() returns non-zero, the user has to
34 * call this function in a loop until it is no longer set or EOF
35 * reached. Otherwise strange things may happen when an EOF is
36 * reached. */
37
38 typedef struct pa_iochannel pa_iochannel;
39
40 /* Create a new IO channel for the specified file descriptors for
41 input resp. output. It is safe to pass the same file descriptor for
42 both parameters (in case of full-duplex channels). For a simplex
43 channel specify -1 for the other direction. */
44
45 pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
46 void pa_iochannel_free(pa_iochannel*io);
47
48 ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
49 ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);
50
51 int pa_iochannel_is_readable(pa_iochannel*io);
52 int pa_iochannel_is_writable(pa_iochannel*io);
53 int pa_iochannel_is_hungup(pa_iochannel*io);
54
55 /* Don't close the file descirptors when the io channel is freed. By
56 * default the file descriptors are closed. */
57 void pa_iochannel_set_noclose(pa_iochannel*io, int b);
58
59 /* Set the callback function that is called whenever data becomes available for read or write */
60 typedef void (*pa_iochannel_callback_t)(pa_iochannel*io, void *userdata);
61 void pa_iochannel_set_callback(pa_iochannel*io, pa_iochannel_callback_t callback, void *userdata);
62
63 /* In case the file descriptor is a socket, return a pretty-printed string in *s which describes the peer connected */
64 void pa_iochannel_socket_peer_to_string(pa_iochannel*io, char*s, size_t l);
65
66 /* Use setsockopt() to tune the recieve and send buffers of TCP sockets */
67 int pa_iochannel_socket_set_rcvbuf(pa_iochannel*io, size_t l);
68 int pa_iochannel_socket_set_sndbuf(pa_iochannel*io, size_t l);
69
70 pa_mainloop_api* pa_iochannel_get_mainloop_api(pa_iochannel *io);
71
72 #endif