paraslash 0.7.3

[paraslash.git] / send.h

diff --git a/send.h b/send.h
index 67b47e48d9e7fd0b96fa4c5c7abd95594c6e2cf0..3407bc5c28a876f1fb5aca6e748368deb58afe0b 100644 (file)
--- a/send.h
+++ b/send.h
@@ -2,6 +2,10 @@
 
 /** \file send.h Sender-related defines and structures. */
 
+/**
+ * A little preprocessor fu helps to create the sender_subcommand enumeration
+ * below and the list of sender name strings without duplicating the commands.
+ */
 #define SENDER_SUBCOMMANDS \
        SENDER_SUBCOMMAND(add) /**< Add a target (udp only). */ \
        SENDER_SUBCOMMAND(delete) /**< Delete a target (udp only). */ \
@@ -10,12 +14,27 @@
        SENDER_SUBCOMMAND(on) /**< Activate the sender. */ \
        SENDER_SUBCOMMAND(off) /**< Deactivate the sender. */ \
 
+/** Concatenate "SENDER_" and the given arg and append a comma. */
 #define SENDER_SUBCOMMAND(_name) SENDER_ ## _name,
+
+/**
+ * Each sender subcommand gets an SENDER_xxx identifier. The identifier is
+ * passed from the sender command handler to the server process via shared
+ * memory.
+ */
 enum sender_subcommand {
-       SENDER_SUBCOMMANDS
+       SENDER_SUBCOMMANDS /**< List of SENDER_xxx identifiers. */
        NUM_SENDER_CMDS /**< Used as array size in struct \ref sender. */
 };
+
 #undef SENDER_SUBCOMMAND
+
+/**
+ * Redefine it to expand to the stringified name of the sender so that
+ * SENDER_SUBCOMMANDS above now expands to the comma-separated list of sender
+ * name strings. This is used in command.c to define and initialize an array of
+ * char pointers.
+ */
 #define SENDER_SUBCOMMAND(_name) #_name,
 
 /**
@@ -57,27 +76,10 @@ struct sender {
        void (*send)(long unsigned current_chunk, long unsigned chunks_sent,
                const char *buf, size_t len, const char *header_buf,
                size_t header_len);
-       /**
-        * Add file descriptors to fd_sets.
-        *
-        * The pre_select function of each supported sender is called just before
-        * para_server enters its main select loop. Each sender may add its own
-        * file descriptors to the \a rfds or the \a wfds set.
-        *
-        * If a file descriptor was added, \a max_fileno must be increased by
-        * this function, if necessary.
-        *
-        * \sa select(2).
-        */
-       void (*pre_select)(int *max_fileno, fd_set *rfds, fd_set *wfds);
-       /**
-        * Handle the file descriptors which are ready for I/O.
-        *
-        * If the pre_select hook added one ore more file descriptors to the
-        * read or write set, this is the hook to check the result and do any
-        * I/O on those descriptors which are ready for reading/writing.
-        */
-       void (*post_select)(fd_set *rfds, fd_set *wfds);
+       /** Ask the scheduler to monitor file descriptors. */
+       void (*pre_monitor)(struct sched *s);
+       /** Perform I/O on the file descriptors which are ready. */
+       void (*post_monitor)(struct sched *s);
        /**
         * Terminate all connected clients.
         *
@@ -193,7 +195,8 @@ void init_sender_status(struct sender_status *ss,
                const struct lls_opt_result *acl_opt_result,
                const struct lls_opt_result *listen_address_opt_result,
                int default_port, int max_clients, int default_deny);
-char *generic_sender_status(struct sender_status *ss, const char *name);
+void free_sender_status(const struct sender_status *ss);
+__malloc char *generic_sender_status(struct sender_status *ss, const char *name);
 void generic_com_allow(struct sender_command_data *scd,
                struct sender_status *ss);
 void generic_com_deny(struct sender_command_data *scd,
@@ -201,7 +204,7 @@ void generic_com_deny(struct sender_command_data *scd,
 void generic_com_on(struct sender_status *ss, unsigned protocol);
 void generic_acl_deplete(struct list_head *acl);
 void generic_com_off(struct sender_status *ss);
-char *generic_sender_help(void);
-struct sender_client *accept_sender_client(struct sender_status *ss, fd_set *rfds);
+__malloc char *generic_sender_help(void);
+struct sender_client *accept_sender_client(struct sender_status *ss);
 int send_queued_chunks(int fd, struct chunk_queue *cq);
 int parse_fec_url(const char *arg, struct sender_command_data *scd);