client: Be more clear about when one must call wl_display_flush

Blocking in general is not what means it is required to flush, but
blocking on input from the wl_display file descriptor.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
Reviewed-by: Bryce Harrington <bryce@osg.samsung.com>
This commit is contained in:
Jonas Ådahl 2015-10-02 17:32:54 +08:00 committed by Bryce Harrington
parent f755dbde26
commit 5e0ed91774

View file

@ -1777,10 +1777,10 @@ wl_display_get_protocol_error(struct wl_display *display,
* \param display The display context object
* \return The number of bytes sent on success or -1 on failure
*
* Send all buffered data on the client side to the server. Clients
* should call this function before blocking. On success, the number
* of bytes sent to the server is returned. On failure, this
* function returns -1 and errno is set appropriately.
* Send all buffered data on the client side to the server. Clients should
* always call this function before blocking on input from the display fd.
* On success, the number of bytes sent to the server is returned. On
* failure, this function returns -1 and errno is set appropriately.
*
* wl_display_flush() never blocks. It will write as much data as
* possible, but if all data could not be written, errno will be set