X-Git-Url: https://code.delx.au/pulseaudio/blobdiff_plain/a87ba420698b7f58d8eaa9236bb01bf11558ed35..77ebb6567faec67c714c0c91ae1a3bf982197863:/src/pulse/mainloop.h diff --git a/src/pulse/mainloop.h b/src/pulse/mainloop.h index 907e94a7..19b17fa6 100644 --- a/src/pulse/mainloop.h +++ b/src/pulse/mainloop.h @@ -9,7 +9,7 @@ PulseAudio is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published - by the Free Software Foundation; either version 2 of the License, + by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. PulseAudio is distributed in the hope that it will be useful, but @@ -50,7 +50,7 @@ struct pollfd; * * -# Prepare - Build a list of file descriptors * that need to be monitored and calculate the next timeout. - * -# Poll - Execute the actuall poll() system call. + * -# Poll - Execute the actual poll() system call. * -# Dispatch - Dispatch any events that have fired. * * When using the main loop, the application can either execute each @@ -71,7 +71,10 @@ struct pollfd; * function. Using the routines defined herein you may create a simple * main loop supporting the generic main loop abstraction layer as * defined in \ref mainloop-api.h. This implementation is thread safe - * as long as you access the main loop object from a single thread only.*/ + * as long as you access the main loop object from a single thread only. + * + * See also \subpage mainloop + */ /** An opaque main loop object */ typedef struct pa_mainloop pa_mainloop; @@ -108,7 +111,9 @@ int pa_mainloop_iterate(pa_mainloop *m, int block, int *retval); /** Run unlimited iterations of the main loop object until the main loop's quit() routine is called. */ int pa_mainloop_run(pa_mainloop *m, int *retval); -/** Return the abstract main loop abstraction layer vtable for this main loop. */ +/** Return the abstract main loop abstraction layer vtable for this + main loop. No need to free the API as it is owned by the loop + and is destroyed when the loop is freed. */ pa_mainloop_api* pa_mainloop_get_api(pa_mainloop*m); /** Shutdown the main loop */