Re: [Qemu-devel] [PATCH] main-loop: document IOCanReadHandler

[Philippe Mathieu-Daudé]

On 06/02/2018 05:52 AM, Stefan Hajnoczi wrote:
> Signed-off-by: Stefan Hajnoczi <address@hidden>
> ---
>  include/qemu/main-loop.h | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/include/qemu/main-loop.h b/include/qemu/main-loop.h
> index 6b4b60bf6d..721aa2416a 100644
> --- a/include/qemu/main-loop.h
> +++ b/include/qemu/main-loop.h
> @@ -168,6 +168,20 @@ void qemu_del_wait_object(HANDLE handle, WaitObjectFunc 
> *func, void *opaque);
>  /* async I/O support */
>  
>  typedef void IOReadHandler(void *opaque, const uint8_t *buf, int size);
> +
> +/**
> + * IOCanReadHandler: Return the number of bytes that #IOReadHandler can 
> accept
> + *
> + * This function reports how many bytes #IOReadHandler is prepared to accept.
> + * #IOReadHandler may be invoked with up to this number of bytes.  If this
> + * function returns 0 then #IOReadHandler is not invoked.
> + *
> + * This function is typically called from an event loop.  If the number of
> + * bytes changes outside the event loop (e.g. because a vcpu thread drained 
> the
> + * buffer), then it is necessary to kick the event loop so that this function
> + * is called again.  aio_notify() or qemu_notify_event() can be used to kick
> + * the event loop.
> + */
>  typedef int IOCanReadHandler(void *opaque);
>  
>  /**
> 

Thanks!

Reviewed-by: Philippe Mathieu-Daudé <address@hidden>