aboutsummaryrefslogtreecommitdiff
path: root/include/chardev
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daudé <philmd@linaro.org>2023-07-05 13:21:11 +0200
committerPhilippe Mathieu-Daudé <philmd@linaro.org>2023-08-31 19:47:43 +0200
commitb3a1090fe55669e4ce19649525745ce551232a43 (patch)
tree83ec668baee4865012e3cfe3f5e27bf06f2893ef /include/chardev
parent8347f4922822da69d44448d4debeb816ebd3ee1a (diff)
downloadqemu-b3a1090fe55669e4ce19649525745ce551232a43.zip
qemu-b3a1090fe55669e4ce19649525745ce551232a43.tar.gz
qemu-b3a1090fe55669e4ce19649525745ce551232a43.tar.bz2
chardev/char-fe: Document FEWatchFunc typedef
Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org> Acked-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20230705133139.54419-4-philmd@linaro.org>
Diffstat (limited to 'include/chardev')
-rw-r--r--include/chardev/char-fe.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/include/chardev/char-fe.h b/include/chardev/char-fe.h
index 8c420fa..0109602 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);
/**