ui/console: add doc comment for qemu_console_{un}register_listener()
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Marc-André Lureau committed
Apr 4, 2026 at 18:45 UTC
2f6e359c5b3a02e6cb30866a7fd2566153cd7892
1 file changed
+20
ui/console.c
+20
@@ -572,6 +572,17 @@ dcl_set_graphic_cursor(DisplayChangeListener *dcl, QemuGraphicConsole *con)
572
}
573
}
574
575
+/*
576
+ * qemu_console_register_listener:
577
+ * @con: the console to attach the listener to
578
+ * @dcl: the display change listener to register
579
+ * @ops: the listener operations (callbacks for display updates)
580
+ *
581
+ * Register a display change listener on a console. The listener
582
+ * must not already be registered (i.e. @dcl->ds must be NULL).
583
+ * This sets up the listener, adds it to the display state, triggers
584
+ * an initial display update, and setup the cursor.
585
+ */
586
void qemu_console_register_listener(QemuConsole *con,
587
DisplayChangeListener *dcl,
588
const DisplayChangeListenerOps *ops)
@@ -605,6 +616,15 @@ void update_displaychangelistener(DisplayChangeListener *dcl,
616
}
617
}
618
619
+/*
620
+ * qemu_console_unregister_listener:
621
+ * @dcl: the display change listener to unregister
622
+ *
623
+ * Unregister a display change listener, removing it from the
624
+ * display state's listener list. If the listener is not currently
625
+ * registered (@dcl->ds is NULL), this is a no-op. After unregistering,
626
+ * the display refresh timer is recalculated.
627
+ */
628
void qemu_console_unregister_listener(DisplayChangeListener *dcl)
629
{
630
DisplayState *ds = dcl->ds;