diff mbox series

[3/4] chardev/char-fe: Document FEWatchFunc typedef

Message ID 20230705133139.54419-4-philmd@linaro.org
State Superseded
Headers show
Series chardev/char-fe: Document FEWatchFunc and use G_SOURCE_CONTINUE/REMOVE | expand

Commit Message

Philippe Mathieu-Daudé July 5, 2023, 1:31 p.m. UTC
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
 include/chardev/char-fe.h | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Marc-André Lureau July 10, 2023, 11:22 a.m. UTC | #1
Hi

On Wed, Jul 5, 2023 at 5:33 PM Philippe Mathieu-Daudé <philmd@linaro.org>
wrote:

> Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> ---
>  include/chardev/char-fe.h | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
>
> diff --git a/include/chardev/char-fe.h b/include/chardev/char-fe.h
> index 309960046a..ec3f706a14 100644
> --- a/include/chardev/char-fe.h
> +++ b/include/chardev/char-fe.h
> @@ -175,6 +175,20 @@ void qemu_chr_fe_printf(CharBackend *be, const char
> *fmt, ...)
>      G_GNUC_PRINTF(2, 3);
>
>
> +/**
> + * FEWatchFunc: a #GSourceFunc called when any conditions requested by
> + *              qemu_chr_fe_add_watch() is satisfied.
> + * @do_not_use: depending on the underlying chardev, a GIOChannel or a
> + *              QIOChannel. DO NOT USE!
> + * @cond: bitwise combination of conditions watched and satisfied
> + *              before calling this callback.
> + * @data: user data passed at creation to qemu_chr_fe_add_watch(). Can
> + *              be NULL.
> + *
> + * Returns: G_SOURCE_REMOVE if the GSource should be removed from the
> + *              main loop, or G_SOURCE_CONTINUE to leave the GSource in
> + *              the main loop.
> + */
>  typedef gboolean (*FEWatchFunc)(void *do_not_use, GIOCondition condition,
> void *data);
>
>  /**
> --
> 2.38.1
>
>
>
Acked-by: Marc-André Lureau <marcandre.lureau@redhat.com>
diff mbox series

Patch

diff --git a/include/chardev/char-fe.h b/include/chardev/char-fe.h
index 309960046a..ec3f706a14 100644
--- a/include/chardev/char-fe.h
+++ b/include/chardev/char-fe.h
@@ -175,6 +175,20 @@  void qemu_chr_fe_printf(CharBackend *be, const char *fmt, ...)
     G_GNUC_PRINTF(2, 3);
 
 
+/**
+ * FEWatchFunc: a #GSourceFunc called when any conditions requested by
+ *              qemu_chr_fe_add_watch() is satisfied.
+ * @do_not_use: depending on the underlying chardev, a GIOChannel or a
+ *              QIOChannel. DO NOT USE!
+ * @cond: bitwise combination of conditions watched and satisfied
+ *              before calling this callback.
+ * @data: user data passed at creation to qemu_chr_fe_add_watch(). Can
+ *              be NULL.
+ *
+ * Returns: G_SOURCE_REMOVE if the GSource should be removed from the
+ *              main loop, or G_SOURCE_CONTINUE to leave the GSource in
+ *              the main loop.
+ */
 typedef gboolean (*FEWatchFunc)(void *do_not_use, GIOCondition condition, void *data);
 
 /**