From c42e45c5ae4b150faaad0c30e53ff323cfe3787a Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 20 Dec 2009 15:57:29 +0100 Subject: [PATCH] client.h: Cosmetics. --- client.h | 54 +++++++++++++++++++++++++----------------------------- 1 file changed, 25 insertions(+), 29 deletions(-) diff --git a/client.h b/client.h index 5fc33682..98dc32db 100644 --- a/client.h +++ b/client.h @@ -4,66 +4,62 @@ * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file client.h common client functions and exported symbols from client_common.c */ +/** \file client.h Common client functions and exported symbols from client_common.c. */ #include -/** - * the different states of a connection from the view of the client - */ +/** The different states of a connection from the view of the client. */ enum { - /** tcp connection is established */ + /** TCP connection is established. */ CL_CONNECTED, - /** server sends the welcome message */ + /** Server sends the welcome message. */ CL_RECEIVED_WELCOME, - /** client sends the authentification request */ + /** Client sends the authentification request. */ CL_SENT_AUTH, - /** server sends a challenge */ + /** Server sends a challenge. */ CL_RECEIVED_CHALLENGE, - /** clientd solves the challenge and sends the result */ + /** Client solves the challenge and sends the result. */ CL_SENT_CH_RESPONSE, - /** server accepts this authentication */ + /** Server accepts this authentication. */ CL_RECEIVED_PROCEED, - /** client sends the command */ + /** Client sends the command. */ CL_SENT_COMMAND, - /** server expects data */ + /** Server expects data. */ CL_SENDING, - /** client expects data */ + /** Client expects data. */ CL_RECEIVING, }; -/** size of the receiving buffer */ +/** The size of the receiving buffer. */ #define CLIENT_BUFSIZE 8192 -/** - * data specific to a client task - */ +/** Data specific to a client task. */ struct client_task { - /** the state of the connection */ + /** The state of the connection. */ int status; /** The file descriptor and the rc4 keys. */ struct rc4_context rc4c; - /** the configuration (including the command) */ + /** The configuration (including the command). */ struct client_args_info conf; - /** the config file for client options */ + /** The config file for client options. */ char *config_file; - /** the RSA private key */ + /** The RSA private key. */ char *key_file; - /** paraslash user name */ + /** Paraslash user name. */ char *user; - /** the client task structure */ + /** The client task structure. */ struct task task; - /** the buffer used for handshake and receiving */ + /** The buffer used for handshake and receiving. */ char *buf; - /** number of bytes loaded in \p buf */ + /** Number of bytes loaded in \a buf. */ size_t loaded; - /** non-zero if the pre_select hook added \p fd to the read fd set */ + /** Non-zero if the pre_select hook added \a fd to the read fd set. */ int check_r; - /** non-zero if the pre_select hook added \p fd to the write fd set */ + /** Non-zero if the pre_select hook added \a fd to the write fd set. */ int check_w; - /** pointer to the data to be sent to para_server */ + /** Pointer to the data to be sent to para_server. */ char *inbuf; - /** number of bytes loaded in \p inbuf */ + /** Number of bytes loaded in \a inbuf. */ size_t *in_loaded; /** Non-zero if input task encountered an eof or an error condition. */ int *in_error; -- 2.39.5