X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=f6aafbb41a2bf9b089f2ddcc9968278dea734fa1;hp=8a69cb714ecd6c4a33d5c9c3bd8e99a9b3aff454;hb=HEAD;hpb=42ddd68159d7eff0f3e7c225665c97f9abd59425 diff --git a/send.h b/send.h index 8a69cb71..3407bc5c 100644 --- a/send.h +++ b/send.h @@ -1,31 +1,56 @@ -/* - * Copyright (C) 2005-2014 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2005 Andre Noll , see file COPYING. */ /** \file send.h Sender-related defines and structures. */ -/** The sender subcommands. */ -enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS}; +/** + * 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(allow) /**< Allow connections from given IP address(es). */ \ + SENDER_SUBCOMMAND(deny) /**< Deny connections from given IP address(es). */ \ + 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 /**< 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, /** * Describes one supported sender of para_server. * - * \sa http_send.c udp_send.c, dccp_send.c. + * \sa \ref http_send.c \ref udp_send.c, \ref dccp_send.c. */ 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. * @@ -37,7 +62,7 @@ struct sender { * * The result must be dynamically allocated and is freed by the caller. */ - char* (*info)(void); + char* (*status)(void); /** * The send-hook. * @@ -51,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. * @@ -79,6 +87,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. * @@ -98,6 +108,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. */ @@ -151,10 +166,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. */ @@ -167,19 +186,25 @@ 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, char **access_arg, int num_access_args, - int port, int max_clients, int default_deny); -char *get_sender_info(struct sender_status *ss, const char *name); - +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); +__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, 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); +__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);