* \return A new event queue associated with this display or NULL on
* failure.
*
- * \memberof wl_display
+ * \memberof wl_event_queue
*/
WL_EXPORT struct wl_event_queue *
wl_display_create_queue(struct wl_display *display)
* with calling wl_display_prepare_read() and wl_display_read_events())
*
* \sa wl_display_roundtrip()
- * \memberof wl_display
+ * \memberof wl_event_queue
*/
WL_EXPORT int
wl_display_roundtrip_queue(struct wl_display *display, struct wl_event_queue *queue)
return -1;
}
+/** Prepare to read events from the display to this queue
+ *
+ * \param display The display context object
+ * \param queue The event queue to use
+ * \return 0 on success or -1 if event queue was not empty
+ *
+ * Atomically makes sure the queue is empty and stops any other thread
+ * from placing events into this (or any) queue. Caller must
+ * eventually call either wl_display_cancel_read() or
+ * wl_display_read_events(), usually after waiting for the
+ * display fd to become ready for reading, to release the lock.
+ *
+ * \sa wl_display_prepare_read
+ * \memberof wl_event_queue
+ */
WL_EXPORT int
wl_display_prepare_read_queue(struct wl_display *display,
struct wl_event_queue *queue)
* \sa wl_display_dispatch(), wl_display_dispatch_pending(),
* wl_display_dispatch_queue_pending()
*
- * \memberof wl_display
+ * \memberof wl_event_queue
*/
WL_EXPORT int
wl_display_dispatch_queue(struct wl_display *display,
* event queue. On failure -1 is returned and errno set appropriately.
* If there are no events queued, this function returns immediately.
*
- * \memberof wl_display
+ * \memberof wl_event_queue
* \since 1.0.2
*/
WL_EXPORT int