remap: Change remapping function argument type from void to int16_t / float as approp...

[pulseaudio] / src / pulsecore / iochannel.h

diff --git a/src/pulsecore/iochannel.h b/src/pulsecore/iochannel.h
index 9050df90f6fef1a3de8f1fae72e0aa50d662d49c..e95f46f7890b94c1461b5d8bdd3eb07ea8bad54f 100644 (file)
--- a/src/pulsecore/iochannel.h
+++ b/src/pulsecore/iochannel.h
@@ -34,15 +34,10 @@
 #include <pulsecore/macro.h>
 
 /* A wrapper around UNIX file descriptors for attaching them to the a
-   main event loop. Everytime new data may be read or be written to
+   main event loop. Every time new data may be read or be written to
    the channel a callback function is called. It is safe to destroy
    the calling iochannel object from the callback */
 
-/* When pa_iochannel_is_readable() returns non-zero, the user has to
- * call this function in a loop until it is no longer set or EOF
- * reached. Otherwise strange things may happen when an EOF is
- * reached. */
-
 typedef struct pa_iochannel pa_iochannel;
 
 /* Create a new IO channel for the specified file descriptors for
@@ -53,24 +48,26 @@ channel specify -1 for the other direction. */
 pa_iochannel* pa_iochannel_new(pa_mainloop_api*m, int ifd, int ofd);
 void pa_iochannel_free(pa_iochannel*io);
 
+/* Returns: length written on success, 0 if a retry is needed, negative value
+ * on error. */
 ssize_t pa_iochannel_write(pa_iochannel*io, const void*data, size_t l);
 ssize_t pa_iochannel_read(pa_iochannel*io, void*data, size_t l);
 
 #ifdef HAVE_CREDS
-pa_bool_t pa_iochannel_creds_supported(pa_iochannel *io);
+bool pa_iochannel_creds_supported(pa_iochannel *io);
 int pa_iochannel_creds_enable(pa_iochannel *io);
 
 ssize_t pa_iochannel_write_with_creds(pa_iochannel*io, const void*data, size_t l, const pa_creds *ucred);
-ssize_t pa_iochannel_read_with_creds(pa_iochannel*io, void*data, size_t l, pa_creds *ucred, pa_bool_t *creds_valid);
+ssize_t pa_iochannel_read_with_creds(pa_iochannel*io, void*data, size_t l, pa_creds *ucred, bool *creds_valid);
 #endif
 
-pa_bool_t pa_iochannel_is_readable(pa_iochannel*io);
-pa_bool_t pa_iochannel_is_writable(pa_iochannel*io);
-pa_bool_t pa_iochannel_is_hungup(pa_iochannel*io);
+bool pa_iochannel_is_readable(pa_iochannel*io);
+bool pa_iochannel_is_writable(pa_iochannel*io);
+bool pa_iochannel_is_hungup(pa_iochannel*io);
 
-/* Don't close the file descirptors when the io channel is freed. By
+/* Don't close the file descriptors when the io channel is freed. By
  * default the file descriptors are closed. */
-void pa_iochannel_set_noclose(pa_iochannel*io, pa_bool_t b);
+void pa_iochannel_set_noclose(pa_iochannel*io, bool b);
 
 /* Set the callback function that is called whenever data becomes available for read or write */
 typedef void (*pa_iochannel_cb_t)(pa_iochannel*io, void *userdata);
@@ -79,11 +76,11 @@ void pa_iochannel_set_callback(pa_iochannel*io, pa_iochannel_cb_t callback, void
 /* In case the file descriptor is a socket, return a pretty-printed string in *s which describes the peer connected */
 void pa_iochannel_socket_peer_to_string(pa_iochannel*io, char*s, size_t l);
 
-/* Use setsockopt() to tune the recieve and send buffers of TCP sockets */
+/* Use setsockopt() to tune the receive and send buffers of TCP sockets */
 int pa_iochannel_socket_set_rcvbuf(pa_iochannel*io, size_t l);
 int pa_iochannel_socket_set_sndbuf(pa_iochannel*io, size_t l);
 
-pa_bool_t pa_iochannel_socket_is_local(pa_iochannel *io);
+bool pa_iochannel_socket_is_local(pa_iochannel *io);
 
 pa_mainloop_api* pa_iochannel_get_mainloop_api(pa_iochannel *io);