X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=67b47e48d9e7fd0b96fa4c5c7abd95594c6e2cf0;hp=acf62db4f80ca6e82b9c5db3d77e942211b20d4f;hb=f5c010bd27e131fca0c2ae58ebdde80e44655dcc;hpb=8dab386f87d2998fd26126600ca7faf56d5a35d1 diff --git a/send.h b/send.h index acf62db4..67b47e48 100644 --- a/send.h +++ b/send.h @@ -1,31 +1,37 @@ -/* - * Copyright (C) 2005-2010 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. * @@ -47,7 +53,7 @@ struct sender { * only differ if the stream was repositioned by the \a ff or \a jmp * command. Of course, \a buf is a pointer to the chunk of data which * should be sent, and \a len is the length of this buffer. - */ + */ void (*send)(long unsigned current_chunk, long unsigned chunks_sent, const char *buf, size_t len, const char *header_buf, size_t header_len); @@ -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. * @@ -87,8 +95,22 @@ struct sender { * pointer means this command is not implemented by this sender. */ int (*client_cmds[NUM_SENDER_CMDS])(struct sender_command_data*); + /** + * Resolve target-specific URL string + * + * This method must be defined if the sender supports the add/delete + * subcommands. It interprets a string specifying a target URL in a + * sender-specific fashion (e.g. embedded FEC string). It can also + * fill in sender-specific defaults if necessary. + */ + 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. */ @@ -105,12 +127,51 @@ struct sender_client { void *private_data; }; +/** + * Each paraslash sender may register arbitrary many clients to the virtual + * streaming system, possibly with varying fec parameters. In order to do so, + * it must allocate a \a fec_client_parms structure and pass it to \ref + * vss_add_fec_client. + * + * Clients are automatically removed from that list by the vss if an error + * occurs, or if the sender requests deletion of a client by calling \ref + * vss_del_fec_client(). + */ + +/** FEC parameters requested by FEC clients. */ +struct fec_client_parms { + /** Number of data slices plus redundant slices. */ + uint8_t slices_per_group; + /** Number of slices minus number of redundant slices. */ + uint8_t data_slices_per_group; + /** Whether the header must be sent periodically. */ + bool need_periodic_header; + /** + * Transport-layer initialisation for FEC support. + * + * This optional function serves (a) to make the transport layer + * ready to send FEC slices and (b) to determine the Maximum + * Packet Size (MPS) supported by the connection. The MPS value + * determines the largest payload size. This value is used to + * send FEC slices that are not larger than the path MTU, to avoid + * fragmentation and to maximize packet utilization. The user can + * alternatively specify a slice size of up to this value. + */ + int (*init_fec)(struct sender_client *sc); + /** Push out FEC-encoded packets */ + void (*send_fec)(struct sender_client *sc, char *buf, size_t len); +}; + /** 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. */ @@ -123,24 +184,24 @@ 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 send_chunk(struct sender_client *sc, struct sender_status *ss, - size_t max_bytes_per_write, long unsigned current_chunk, - const char *buf, size_t len, const char *header_buf, - size_t header_len); -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); +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); -int send_queued_chunks(int fd, struct chunk_queue *cq, - size_t max_bytes_per_write); +int send_queued_chunks(int fd, struct chunk_queue *cq); int parse_fec_url(const char *arg, struct sender_command_data *scd);