X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=f6aafbb41a2bf9b089f2ddcc9968278dea734fa1;hp=cff1abd52c23a40f3eebfbbb173a99522ad2a6a4;hb=d5e27e2a346da2f18188d317926a60687d082732;hpb=4fbe16430b4776814128d7110682c69d1b047c57

diff --git a/send.h b/send.h
index cff1abd5..f6aafbb4 100644
--- 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,
 
 /**
@@ -27,14 +46,11 @@ struct sender {
 	/** The name of the sender. */
 	const char *name;
 	/**
-	 * The init function of this sender.
-	 *
-	 * It must fill in all function pointers of \a s as well as the \a
-	 * client_cmds array, see below. It should also do all necessary
-	 * preparations to init this sending facility, for example it could
-	 * open a tcp port.
+	 * Parse the command line options and initialize this sender (e.g.,
+	 * initialize target or access control lists, listen on a network
+	 * socket, etc.).
 	 */
-	void (*init)(struct sender *s);
+	void (*init)(void);
 	/**
 	 * Return the help text of this sender.
 	 *
@@ -88,6 +104,8 @@ struct sender {
 	 * the clients aware of the end-of-file condition.
 	 */
 	void (*shutdown_clients)(void);
+	/** Dellocate all resources. Only called on exit. */
+	void (*shutdown)(void);
 	/**
 	 * Array of function pointers for the sender subcommands.
 	 *
@@ -107,6 +125,11 @@ struct sender {
 	int (*resolve_target)(const char *, struct sender_command_data *);
 };
 
+/** NULL-terminated list, defined in \ref vss.c. */
+extern const struct sender * const senders[];
+/** Iterate over all senders. */
+#define FOR_EACH_SENDER(_i) for ((_i) = 0; senders[(_i)]; (_i)++)
+
 /** Describes one client, connected to a paraslash sender. */
 struct sender_client {
 	/** The file descriptor of the client. */
@@ -189,12 +212,14 @@ 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);
+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);
 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);