Add comments to client data.

This commit is contained in:
Michael Jumper 2013-05-25 23:56:59 -07:00
parent 2a6de3aaed
commit 2f7e0eec41

View File

@ -50,17 +50,49 @@
*/ */
typedef struct ssh_guac_client_data { typedef struct ssh_guac_client_data {
/**
* The hostname of the SSH server to connect to.
*/
char hostname[1024]; char hostname[1024];
/**
* The port of the SSH server to connect to.
*/
int port; int port;
/**
* The name of the user to login as.
*/
char username[1024]; char username[1024];
/**
* The password to give when authenticating.
*/
char password[1024]; char password[1024];
/**
* The name of the font to use for display rendering.
*/
char font_name[1024]; char font_name[1024];
/**
* The size of the font to use, in points.
*/
int font_size; int font_size;
/**
* The SSH client thread.
*/
pthread_t client_thread; pthread_t client_thread;
/**
* SSH session, used by the SSH client thread.
*/
ssh_session session; ssh_session session;
/**
* SSH terminal channel, used by the SSH client thread.
*/
ssh_channel term_channel; ssh_channel term_channel;
/** /**