doxify client.h
authorAndre <maan@p133.(none)>
Thu, 15 Jun 2006 14:58:18 +0000 (16:58 +0200)
committerAndre <maan@p133.(none)>
Thu, 15 Jun 2006 14:58:18 +0000 (16:58 +0200)
and add documentation for enable_crypt() and enable_crypt().

audiod.c
client.c
client.h
client_common.c
gui.ggo
net.c

index 032b608..e298946 100644 (file)
--- a/audiod.c
+++ b/audiod.c
@@ -991,7 +991,7 @@ static void status_post_select(__a_unused struct sched *s, struct task *t)
 
        t->ret = 1;
        if (!st->pcd || !st->pcd->loaded
-                       || st->pcd->status != CL_RECEIVING_SERVER_OUTPUT)
+                       || st->pcd->status != CL_RECEIVING)
                return;
        st->pcd->loaded = for_each_line(st->pcd->buf, st->pcd->loaded,
                &check_stat_line);
index 69e0f3d..95dacd7 100644 (file)
--- a/client.c
+++ b/client.c
@@ -59,7 +59,7 @@ static void client_event_handler(struct task *t)
                p->eof = 1;
                return;
        }
-       if (p->status == CL_SENDING_STDIN) {
+       if (p->status == CL_SENDING) {
                stdin_set_defaults(&sit);
                sit.buf = para_malloc(sit.bufsize),
                register_task(&sit.task);
index 8f7b9a5..1c9a8c2 100644 (file)
--- a/client.h
+++ b/client.h
 /** \file client.h common client functions and exported symbols from client_common.c */
 
 #include <openssl/rc4.h>
+
+/**
+ * the different states of a connection from the view of the client
+ */
 enum {
+       /** tcp connection is established */
        CL_CONNECTED,
+       /** server sends the welcome message */
        CL_RECEIVED_WELCOME,
+       /** client sends the authentification request */
        CL_SENT_AUTH,
+       /** server sends a challenge */
        CL_RECEIVED_CHALLENGE,
+       /** clientd solves the challenge and sends the result */
        CL_SENT_CH_RESPONSE,
+       /** server accepts this authentication */
        CL_RECEIVED_PROCEED,
+       /** client sends the command */
        CL_SENT_COMMAND,
-       CL_SENDING_STDIN,
-       CL_RECEIVING_SERVER_OUTPUT
+       /** server expects data */
+       CL_SENDING,
+       /** client expects data */
+       CL_RECEIVING,
 };
 
 #define CLIENT_BUFSIZE 8192
 
+/**
+ * data specific to a client task
+ */
 struct private_client_data {
+       /** the state of the connection */
        int status;
+       /** the file descriptor */
        int fd;
+       /** the configuration (including the command) */
        struct client_args_info conf;
+       /** the config file for client options */
        char *config_file;
+       /** the RSA private key */
        char *key_file;
+       /** paraslash user name */
        char *user;
+       /** session key for receiving data */
        RC4_KEY rc4_recv_key;
+       /** session key for sending data */
        RC4_KEY rc4_send_key;
+       /** the client task structure */
        struct task task;
+       /** non-zero if task is unregistered */
        int eof;
+       /** the buffer used for handshake and receiving */
        char buf[CLIENT_BUFSIZE];
+       /** number of bytes loaded in \p buf */
        size_t loaded;
+       /** non-zero if the pre_select hook added \p fd to the read fd set */
        int check_r;
+       /** non-zero if the pre_select hook added \p fd to the write fd set */
        int check_w;
+       /** the decrypted challenge */
        long unsigned challenge_nr;
-       /* only used if stdin gets sent to para_server */
+       /** pointer to the data to be sent to para_server */
        char *inbuf;
+       /** number of bytes loaded in \p inbuf */
        size_t *in_loaded;
+       /** non-zero if input task encountered an eof or an errro condition */
        int *in_eof;
 };
 
index 409c51d..8bca7b7 100644 (file)
@@ -129,13 +129,13 @@ void client_pre_select(struct sched *s, struct task *t)
                pcd->check_w = 1;
                return;
 
-       case CL_RECEIVING_SERVER_OUTPUT:
+       case CL_RECEIVING:
                if (pcd->loaded < CLIENT_BUFSIZE - 1) {
                        para_fd_set(pcd->fd, &s->rfds, &s->max_fileno);
                        pcd->check_r = 1;
                }
                return;
-       case CL_SENDING_STDIN:
+       case CL_SENDING:
                if (*pcd->in_loaded) {
                        PARA_INFO_LOG("loaded: %zd\n", *pcd->in_loaded);
                        para_fd_set(pcd->fd, &s->wfds, &s->max_fileno);
@@ -269,11 +269,11 @@ void client_post_select(struct sched *s, struct task *t)
                        return;
                t->ret = -E_HANDSHAKE_COMPLETE;
                if (strstr(pcd->buf, AWAITING_DATA_MSG))
-                       pcd->status = CL_SENDING_STDIN;
+                       pcd->status = CL_SENDING;
                else
-                       pcd->status = CL_RECEIVING_SERVER_OUTPUT;
+                       pcd->status = CL_RECEIVING;
                return;
-       case CL_SENDING_STDIN: /* FIXME: might block */
+       case CL_SENDING: /* FIXME: might block */
                PARA_INFO_LOG("loaded: %zd\n", *pcd->in_loaded);
                t->ret = send_bin_buffer(pcd->fd, pcd->inbuf, *pcd->in_loaded);
                if (t->ret <= 0) {
@@ -283,7 +283,7 @@ void client_post_select(struct sched *s, struct task *t)
                }
                *pcd->in_loaded = 0; /* FIXME: short writes */
                return;
-       case CL_RECEIVING_SERVER_OUTPUT:
+       case CL_RECEIVING:
                t->ret = client_recv_buffer(pcd);
                return;
        }
diff --git a/gui.ggo b/gui.ggo
index ab42144..34cbdb1 100644 (file)
--- a/gui.ggo
+++ b/gui.ggo
@@ -2,7 +2,7 @@ section "general options"
 option "auto_decode" a "auto-decode audio stream" flag on
 option "config_file" c "(default='~/.paraslash/gui.conf')" string typestr="filename" optional
 option "loglevel" l "set loglevel (0-6)" int typestr="level" default="4" optional
-option "timeout" t "set timeout" int typestr="milliseconds" default="300" optional
+option "timeout" t "set timeout" int typestr="milliseconds" default="30" optional
 option "stat_cmd" s "command to read server and audiod status data from" string typestr="command" default="para_audioc -t 100 stat" optional
 
 section "mapping keys to commands"
diff --git a/net.c b/net.c
index 28bc777..5a7eb91 100644 (file)
--- a/net.c
+++ b/net.c
 #include "string.h"
 #include "error.h"
 
+
+/** \cond holds information about one encrypted connection */
 struct crypt_data {
        crypt_function *recv;
        crypt_function *send;
        void *private_data;
 };
-
 static struct crypt_data *crypt_data_array;
 static unsigned cda_size = 0;
+/** \endcond */
+
 
+/**
+ * activate encryption for one file descriptor
+ *
+ * \param fd the file descriptor
+ * \param recv the function used for decrypting received data
+ * \param send the function used for encrypting before sending
+ * \param private_data user data supplied by the caller
+ */
 void enable_crypt(int fd, crypt_function *recv, crypt_function *send,
        void *private_data)
 {
@@ -48,6 +59,13 @@ void enable_crypt(int fd, crypt_function *recv, crypt_function *send,
        PARA_INFO_LOG("rc4 encryption activated for fd %d\n", fd);
 }
 
+/**
+ * deactivate encryption for a given fd
+ *
+ * \param fd the file descriptor
+ *
+ * This must be called if and only if \p fd was activated via enable_crypt().
+ */
 void disable_crypt(int fd)
 {
        if (cda_size < fd + 1)