X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=f88ebd84897a89df5b748ab86acb399c37917e0a;hp=05c5ed7615729219990859d2f953f85b96437c0a;hb=9d232e636d79a2321e280fe3eee6839c8f45c36f;hpb=b62e2796b85c7d7f3138fe729f4637853e0fafe0 diff --git a/recv.h b/recv.h index 05c5ed76..f88ebd84 100644 --- a/recv.h +++ b/recv.h @@ -1,8 +1,4 @@ -/* - * Copyright (C) 2005-2011 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2005 Andre Noll , see file COPYING. */ /** \file recv.h Receiver-related structures and exported symbols of recv_common.c. */ @@ -11,56 +7,52 @@ */ struct receiver_node { /** Points to the corresponding receiver. */ - struct receiver *receiver; + const struct receiver *receiver; /** Receiver-specific data. */ void *private_data; - /** Pointer to the configuration data for this instance. */ - void *conf; + /** The parsed command line options for this instance. */ + struct lls_parse_result *lpr; /** The task associated with this instance. */ - struct task task; + struct task *task; /** The receiver node is always the root of the buffer tree. */ struct btr_node *btrn; + /** Each receiver node maintains a buffer pool for the received data. */ + struct btr_pool *btrp; + /** + * The file descriptor to receive the stream. + * + * The pre_select function of the receiver adds this file descriptor to + * the set of file descriptors which are watched for readability or + * writability, depending on the state of the connection (if any). + * + * If \a fd is readable, the post_select function of the receiver reads + * data from this fd into the buffer pool area of \a btrp. + * + * \sa \ref receiver. + */ + int fd; }; /** * Describes one supported paraslash receiver. * - * \sa http_recv.c, udp_recv.c + * \sa \ref http_recv.c, \ref udp_recv.c. */ struct receiver { /** - * The name of the receiver. - */ - const char *name; - /** - * The receiver init function. + * The optional receiver init function. * - * It must fill in all other function pointers and is assumed to succeed. - * - * \sa http_recv_init udp_recv_init. + * Performs any initialization needed before the receiver can be opened. */ - void (*init)(struct receiver *r); - /** - * The command line parser of the receiver. - * - * It should check whether the command line options given by \a argc and \a - * argv are valid. On success, it should return a pointer to the - * receiver-specific configuration data determined by \a argc and \a argv. - * Note that this might be called more than once with different values of - * \a argc and \a argv. - */ - void *(*parse_config)(int argc, char **argv); - void (*free_config)(void *conf); + void (*init)(void); /** * Open one instance of the receiver. * - * This should allocate the output buffer of \a rn. and may also - * perform any other work necessary for retrieving the stream according - * to the configuration stored in the \a conf member of \a rn which is - * guaranteed to point to valid configuration data (as previously - * obtained from the config parser). + * This should allocate the output buffer of the given receiver node + * and prepare it for retrieving the audio stream according to the + * configuration stored in rn->lpr. * - * \sa receiver_node::conf, receiver_node::buf. + * \sa struct \ref receiver_node. */ int (*open)(struct receiver_node *rn); /** @@ -69,60 +61,60 @@ struct receiver { * It should free all resources associated with given receiver node * that were allocated during the corresponding open call. * - * \sa receiver_node. + * \sa \ref receiver_node. */ void (*close)(struct receiver_node *rn); /** * Add file descriptors to fd_sets and compute timeout for select(2). * - * The pre_select function gets called from the driving application - * before entering its select loop. The receiver may use this hook to - * add any file descriptors to the sets of file descriptors given by \a - * s. + * If this is not NULL, the function is called in each iteration of the + * scheduler's select loop. The receiver may define it to add file + * descriptors to the file descriptor sets given by s. Those will be + * monitored in the subsequent call to select(2). The function may also + * lower the timeout value of s to make select(2) return earlier if no + * file descriptors are ready for I/O. * - * \sa select(2), time.c struct task, struct sched. + * \sa select(2), \ref time.c, struct \ref sched. */ - void (*pre_select)(struct sched *s, struct task *t); + void (*pre_select)(struct sched *s, void *context); /** - * Evaluate the result from select(). + * Evaluate the result from select(2). * - * This hook gets called after the call to select(). It should check - * all file descriptors which were added to any of the the fd sets - * during the previous call to pre_select. According to the result, it - * may then use any non-blocking I/O to establish a connection or to - * receive the audio data. + * This is called after the call to select(2). It should check all file + * descriptors which were added to any of the fd sets in the previous + * call to ->pre_select() and perform (non-blocking) I/O operations on + * those fds which are ready for I/O, for example in order to establish + * a connection or to receive a part of the audio stream. * - * \sa select(2), struct receiver. + * \sa select(2), struct \ref receiver. */ - void (*post_select)(struct sched *s, struct task *t); - - /** The two help texts of this receiver. */ - struct ggo_help help; + int (*post_select)(struct sched *s, void *context); + /** + * Answer a buffer tree query. + * + * This optional function pointer allows for inter node communication + * of the buffer tree nodes. See \ref btr_command_handler for details. + */ + btr_command_handler execute; }; -/** Define an array of all available receivers. */ -#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \ - HTTP_RECEIVER \ - DCCP_RECEIVER \ - UDP_RECEIVER \ - {.name = NULL}}; +#define RECV_CMD(_num) (lls_cmd(_num, recv_cmd_suite)) + +#define RECV_CMD_OPT_RESULT(_recv, _opt, _lpr) \ + (lls_opt_result(LSG_RECV_CMD_ ## _recv ## _OPT_ ## _opt, _lpr)) +#define RECV_CMD_OPT_GIVEN(_recv, _opt, _lpr) \ + (lls_opt_given(RECV_CMD_OPT_RESULT(_recv, _opt, _lpr))) +#define RECV_CMD_OPT_STRING_VAL(_recv, _opt, _lpr) \ + (lls_string_val(0, RECV_CMD_OPT_RESULT(_recv, _opt, _lpr))) +#define RECV_CMD_OPT_UINT32_VAL(_recv, _opt, _lpr) \ + (lls_uint32_val(0, RECV_CMD_OPT_RESULT(_recv, _opt, _lpr))) +#define RECV_CMD_OPT_INT32_VAL(_recv, _opt, _lpr) \ + (lls_int32_val(0, RECV_CMD_OPT_RESULT(_recv, _opt, _lpr))) /** Iterate over all available receivers. */ -#define FOR_EACH_RECEIVER(i) for (i = 0; receivers[i].name; i++) +#define FOR_EACH_RECEIVER(i) for (i = 1; lls_cmd(i, recv_cmd_suite); i++) void recv_init(void); -void *check_receiver_arg(char *ra, int *receiver_num); -void print_receiver_helps(int detailed); -int generic_recv_pre_select(struct sched *s, struct task *t); - -/** \cond */ -extern void http_recv_init(struct receiver *r); -#define HTTP_RECEIVER {.name = "http", .init = http_recv_init}, -extern void dccp_recv_init(struct receiver *r); -#define DCCP_RECEIVER {.name = "dccp", .init = dccp_recv_init}, -extern void udp_recv_init(struct receiver *r); -#define UDP_RECEIVER {.name = "udp", .init = udp_recv_init}, - -extern struct receiver receivers[]; -/** \endcond */ - +int check_receiver_arg(const char *ra, struct lls_parse_result **lprp); +void print_receiver_helps(bool detailed); +int generic_recv_pre_select(struct sched *s, struct receiver_node *rn);