pulse.mainloop

Undocumented in source.

Members

Aliases

pa_poll_func
alias pa_poll_func = int function(pollfd* ufds, c_ulong nfds, int timeout, void* userdata)

Generic prototype of a poll() like function

Functions

pa_mainloop_dispatch
int pa_mainloop_dispatch(pa_mainloop* m)

Dispatch timeout, io and deferred events from the previously executed poll. Returns a negative value on error. On success returns the number of source dispatched.

pa_mainloop_free
void pa_mainloop_free(pa_mainloop* m)

Free a main loop object

pa_mainloop_get_api
pa_mainloop_api* pa_mainloop_get_api(pa_mainloop* m)

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_get_retval
int pa_mainloop_get_retval(const(pa_mainloop)* m)

Return the return value as specified with the main loop's quit() routine.

pa_mainloop_iterate
int pa_mainloop_iterate(pa_mainloop* m, int block, int* retval)

Run a single iteration of the main loop. This is a convenience function for pa_mainloop_prepare(), pa_mainloop_poll() and pa_mainloop_dispatch(). Returns a negative value on error or exit request. If block is nonzero, block for events if none are queued. Optionally return the return value as specified with the main loop's quit() routine in the integer variable retval points to. On success returns the number of sources dispatched in this iteration.

pa_mainloop_new
pa_mainloop* pa_mainloop_new()

Allocate a new main loop object. Free with pa_mainloop_free.

pa_mainloop_poll
int pa_mainloop_poll(pa_mainloop* m)

Execute the previously prepared poll. Returns a negative value on error.

pa_mainloop_prepare
int pa_mainloop_prepare(pa_mainloop* m, int timeout)

Prepare for a single iteration of the main loop. Returns a negative value on error or exit request. timeout specifies a maximum timeout for the subsequent poll, or -1 for blocking behaviour. The timeout is specified in microseconds.

pa_mainloop_quit
void pa_mainloop_quit(pa_mainloop* m, int retval)

Shutdown the main loop with the specified return value

pa_mainloop_run
int pa_mainloop_run(pa_mainloop* m, int* retval)

Run unlimited iterations of the main loop object until the main loop's quit() routine is called. Returns a negative value on error. Optionally return the return value as specified with the main loop's quit() routine in the integer variable retval points to.

pa_mainloop_set_poll_func
void pa_mainloop_set_poll_func(pa_mainloop* m, pa_poll_func poll_func, void* userdata)

Change the poll() implementation

pa_mainloop_wakeup
void pa_mainloop_wakeup(pa_mainloop* m)

Interrupt a running poll (for threaded systems)

Structs

pa_mainloop
struct pa_mainloop

An opaque main loop object

pollfd
struct pollfd

This file is part of PulseAudio.

Meta