]> git.tue.mpg.de Git - paraslash.git/commitdiff
Add documentation of struct sender status.
authorAndre Noll <maan@systemlinux.org>
Sun, 17 Feb 2008 13:14:10 +0000 (14:14 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 17 Feb 2008 13:14:10 +0000 (14:14 +0100)
send.h

diff --git a/send.h b/send.h
index 8ec5e7baf3386d420b3cb97fdba173c5bfc74fb1..6550c70185f889d97aac6f093e23c21ce55b7267 100644 (file)
--- a/send.h
+++ b/send.h
@@ -104,16 +104,22 @@ struct sender_client {
        void *private_data;
 };
 
+/** Describes the current status of one paraslash sender. */
 struct sender_status {
+       /* The file descriptor of the socket this sender is listening on. */
        int listen_fd;
+       /** The TCP/DCCP port used by this sender. */
        int port;
+       /** The current number of simultaneous connections. */
        int num_clients;
+       /** The maximal number of simultaneous connections. */
        int max_clients;
+       /** Whether the access control list is a whitelist. */
        int default_deny;
-       /** The list of connected clients. */
-       struct list_head client_list;
        /** The whitelist/blacklist. */
        struct list_head acl;
+       /** The list of connected clients. */
+       struct list_head client_list;
 };
 
 void shutdown_client(struct sender_client *sc, struct sender_status *ss);