diff options
| author | Jonas Ådahl <jadahl@gmail.com> | 2015-10-02 17:32:54 +0800 |
|---|---|---|
| committer | Bryce Harrington <bryce@osg.samsung.com> | 2015-10-05 17:28:53 -0700 |
| commit | 5e0ed917744f2f881956e91ebe971073fd0a7c51 (patch) | |
| tree | 77505d56061f341ab1f4b83242931a6582080ba6 /src | |
| parent | client: Reword and add documentation about the marshal functions (diff) | |
| download | wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar.gz wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar.bz2 wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar.lz wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar.xz wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.tar.zst wayland-5e0ed917744f2f881956e91ebe971073fd0a7c51.zip | |
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>
Diffstat (limited to 'src')
| -rw-r--r-- | src/wayland-client.c | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/wayland-client.c b/src/wayland-client.c index f454b94..007de0f 100644 --- a/src/wayland-client.c +++ b/src/wayland-client.c @@ -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 |