GUAC-654: Comment guac_handlers.h properly.

This commit is contained in:
Michael Jumper 2014-05-07 21:29:36 -07:00
parent 13e205a0e5
commit d42cd23f87

View File

@ -27,10 +27,35 @@
#include <guacamole/client.h>
/**
* 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