X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=bca03b2027492a211bdaa5fa02eeaa1b50878ae1;hp=8a69cb714ecd6c4a33d5c9c3bd8e99a9b3aff454;hb=ac4e01ba1a2f302bf31dd511a7aff8da78660b15;hpb=a731a7c6e78fb137268b42062d9fb08b4e49a2c8 diff --git a/send.h b/send.h index 8a69cb71..bca03b20 100644 --- a/send.h +++ b/send.h @@ -1,31 +1,37 @@ -/* - * 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}; +#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. */ \ + +#define SENDER_SUBCOMMAND(_name) SENDER_ ## _name, +enum sender_subcommand { + SENDER_SUBCOMMANDS + NUM_SENDER_CMDS /**< Used as array size in struct \ref sender. */ +}; +#undef SENDER_SUBCOMMAND +#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 +43,7 @@ struct sender { * * The result must be dynamically allocated and is freed by the caller. */ - char* (*info)(void); + char* (*status)(void); /** * The send-hook. * @@ -79,6 +85,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 +106,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. */ @@ -169,10 +182,10 @@ struct sender_status { 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, int port, + int max_clients, int default_deny); +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,