src/pulsecore/iochannel.h

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