From d42cd23f87c71e85380591ab28fcf5415d0e0585 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Wed, 7 May 2014 21:29:36 -0700 Subject: [PATCH] GUAC-654: Comment guac_handlers.h properly. --- src/protocols/telnet/guac_handlers.h | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/protocols/telnet/guac_handlers.h b/src/protocols/telnet/guac_handlers.h index c0348acf..d2b67b7d 100644 --- a/src/protocols/telnet/guac_handlers.h +++ b/src/protocols/telnet/guac_handlers.h @@ -27,10 +27,35 @@ #include +/** + * Generic handler for sending outbound messages. Required by libguac and + * called periodically by guacd when the client is ready for more graphical + * updates. + */ int guac_telnet_client_handle_messages(guac_client* client); + +/** + * Handler for key events. Required by libguac and called whenever key events + * are received. + */ int guac_telnet_client_key_handler(guac_client* client, int keysym, int pressed); + +/** + * Handler for mouse events. Required by libguac and called whenever mouse + * events are received. + */ int guac_telnet_client_mouse_handler(guac_client* client, int x, int y, int mask); + +/** + * Handler for size events. Required by libguac and called whenever the remote + * display (window) is resized. + */ int guac_telnet_client_size_handler(guac_client* client, int width, int height); + +/** + * Free handler. Required by libguac and called when the guac_client is + * disconnected and must be cleaned up. + */ int guac_telnet_client_free_handler(guac_client* client); #endif