/** \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,
/**
* 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.
+ * para_server enters its main select loop. Each sender may watch its own
+ * file descriptors for reading or writing.
*
* \sa select(2).
*/
- void (*pre_select)(int *max_fileno, fd_set *rfds, fd_set *wfds);
+ void (*pre_select)(struct sched *s);
/**
* 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.
+ * If the pre_select hook asked for one or more file descriptors to be
+ * watched, this is the hook to check the result and perform I/O on the
+ * descriptors which are ready for reading/writing.
*/
- void (*post_select)(fd_set *rfds, fd_set *wfds);
+ void (*post_select)(struct sched *s);
/**
* Terminate all connected clients.
*
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_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);
+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);