Merge branch 'refs/heads/t/stale-pointer-fix'
[paraslash.git] / send.h
diff --git a/send.h b/send.h
index bca03b2027492a211bdaa5fa02eeaa1b50878ae1..f6aafbb41a2bf9b089f2ddcc9968278dea734fa1 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). */ \
        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,
 
 /**
@@ -164,10 +183,14 @@ struct fec_client_parms {
 
 /** 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;
+       /** Number of sockets to listen on, size of the two arrays below. */
+       unsigned num_listen_fds;
+       /** Derived from --http-listen-address and --dccp-listen-address. */
+       char **listen_addresses;
+       /** Default TCP/DCCP port number for addresses w/o port. */
+       int default_port;
+       /** The socket fd(s) this sender is listening on. */
+       int *listen_fds;
        /** The current number of simultaneous connections. */
        int num_clients;
        /** The maximal number of simultaneous connections. */
@@ -180,17 +203,23 @@ struct sender_status {
        struct list_head client_list;
 };
 
+/** Iterate over all listening addresses of the http/dccp sender. */
+#define FOR_EACH_LISTEN_FD(_n, _ss) for (_n = 0; _n < (_ss)->num_listen_fds; _n++)
+
 void shutdown_client(struct sender_client *sc, struct sender_status *ss);
 void shutdown_clients(struct sender_status *ss);
 void init_sender_status(struct sender_status *ss,
-               const struct lls_opt_result *acl_opt_result, int port,
-               int max_clients, int default_deny);
+               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);
+void free_sender_status(const struct sender_status *ss);
 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,
                struct sender_status *ss);
-int generic_com_on(struct sender_status *ss, unsigned protocol);
+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);