code.delx.au - pulseaudio/blob - src/pulsecore/iochannel.h

   1 #ifndef fooiochannelhfoo
   2 #define fooiochannelhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   PulseAudio 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   PulseAudio 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 PulseAudio; 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
  27 #include <pulse/mainloop-api.h>
  28
  29 /* A wrapper around UNIX file descriptors for attaching them to the a
  30    main event loop. Everytime new data may be read or be written to
  31    the channel a callback function is called. It is safe to destroy
  32    the calling iochannel object from the callback */
  33
  34 /* When pa_iochannel_is_readable() returns non-zero, the user has to
  35  * call this function in a loop until it is no longer set or EOF
  36  * reached. Otherwise strange things may happen when an EOF is
  37  * reached. */
  38
  39 typedef struct pa_iochannel pa_iochannel;
  40
  41 /* Create a new IO channel for the specified file descriptors for
  42 input resp. output. It is safe to pass the same file descriptor for
  43 both parameters (in case of full-duplex channels). For a simplex
  44 channel specify -1 for the other direction. */
  45
  46 pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
  47 void pa_iochannel_free(pa_iochannel*io);
  48
  49 ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
  50 ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);
  51
  52 int pa_iochannel_creds_supported(pa_iochannel *io);
  53 int pa_iochannel_creds_enable(pa_iochannel *io);
  54
  55 struct ucred;
  56
  57 ssize_t pa_iochannel_write_with_creds(pa_iochannel*io, const void*data, size_t l, const struct ucred *ucred);
  58 ssize_t pa_iochannel_read_with_creds(pa_iochannel*io, void*data, size_t l, struct ucred *ucred, int *creds_valid);
  59
  60 int pa_iochannel_is_readable(pa_iochannel*io);
  61 int pa_iochannel_is_writable(pa_iochannel*io);
  62 int pa_iochannel_is_hungup(pa_iochannel*io);
  63
  64 /* Don't close the file descirptors when the io channel is freed. By
  65  * default the file descriptors are closed. */
  66 void pa_iochannel_set_noclose(pa_iochannel*io, int b);
  67
  68 /* Set the callback function that is called whenever data becomes available for read or write */
  69 typedef void (*pa_iochannel_cb_t)(pa_iochannel*io, void *userdata);
  70 void pa_iochannel_set_callback(pa_iochannel*io, pa_iochannel_cb_t callback, void *userdata);
  71
  72 /* In case the file descriptor is a socket, return a pretty-printed string in *s which describes the peer connected */
  73 void pa_iochannel_socket_peer_to_string(pa_iochannel*io, char*s, size_t l);
  74
  75 /* Use setsockopt() to tune the recieve and send buffers of TCP sockets */
  76 int pa_iochannel_socket_set_rcvbuf(pa_iochannel*io, size_t l);
  77 int pa_iochannel_socket_set_sndbuf(pa_iochannel*io, size_t l);
  78
  79 pa_mainloop_api* pa_iochannel_get_mainloop_api(pa_iochannel *io);
  80
  81 #endif