X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=send.h;h=c84545c97bac51e1ad0fb3755cc878b48021acf9;hp=f831cbc4839b1eb304a8869e234923f375716e88;hb=b55f405f8005821ffa369b929bc0b419da62683d;hpb=f099900540c4e4c54b10181254b895ccfe6ef410 diff --git a/send.h b/send.h index f831cbc4..c84545c9 100644 --- a/send.h +++ b/send.h @@ -1,5 +1,5 @@ /* - * Copyright (C) 2005-2010 Andre Noll + * Copyright (C) 2005-2012 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ @@ -9,43 +9,6 @@ /** The sender subcommands. */ enum {SENDER_ADD, SENDER_DELETE, SENDER_ALLOW, SENDER_DENY, SENDER_ON, SENDER_OFF, NUM_SENDER_CMDS}; -/** - * 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 - * 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(). - */ -struct fec_client; -struct sender_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; - /** Maximal number of bytes per slice, initially zero. */ - uint16_t max_slice_bytes; - /** - * 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 */ - int (*send_fec)(struct sender_client *sc, char *buf, size_t len); -}; - /** * Describes one supported sender of para_server. * @@ -88,23 +51,6 @@ 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); - - /** - * Obtain the FEC parameters of a FEC client. - * - * This is called once by vss.c at the beginning of a stream. Senders - * are supposed to set \a fcp to a struct which is suitable for the FEC - * client identified by \a private_data. - */ - int (*open)(void *client, struct fec_client_parms **fcp); - /** - * Send the next slice to a FEC client. - * - * Called by vss.c when the next slice should be sent to the FEC client - * identified by \a private_data, the pointer which was previously - * passed to vss_add_fec_target(). - */ - int (*send_fec)(char *buf, size_t num_bytes, void *private_data); /** * Add file descriptors to fd_sets. * @@ -141,6 +87,15 @@ 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 *); }; /** Describes one client, connected to a paraslash sender. */ @@ -159,6 +114,41 @@ 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. */ @@ -179,10 +169,6 @@ struct sender_status { 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); @@ -195,6 +181,5 @@ int generic_com_on(struct sender_status *ss, unsigned protocol); 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);