server: Add documentation to struct handler
Add a little documentation for the handler API, as we'll be changing
this with upcoming buffer code.
Change-Id: I0d33c415f577b9bdc6b53bb8151bb7f564733b3d
Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
diff --git a/console-server.h b/console-server.h
index 765fac7..67cc99e 100644
--- a/console-server.h
+++ b/console-server.h
@@ -27,6 +27,20 @@
HANDLER_EXIT,
};
+/*
+ * Console data handlers: these implement the functions that process
+ * data coming out of the main tty device.
+ *
+ * Handlers are registered at link time using the console_handler_register()
+ * macro. We call each handler's ->init() function at startup, and ->fini() at
+ * exit.
+ *
+ * Incoming data from the tty will be passed to the handler through the
+ * ->data_in() function. To send data to the tty, use console_data_out().
+ *
+ * If a handler needs to monitor a separate file descriptor for events, use the
+ * poller API, through console_poller_register().
+ */
struct handler {
const char *name;
int (*init)(struct handler *handler,