X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=f70cbbe8d61d233e6487e1452253162e09a6f6b6;hp=3284c29ad789a359ea9af5253c1cf239a12f7b0d;hb=23b121a85984baa9252f4b4c0b8c4f186e394bb7;hpb=2ed89c59f0efcd0a2763f47c7d3455663241e623 diff --git a/recv.h b/recv.h index 3284c29a..f70cbbe8 100644 --- a/recv.h +++ b/recv.h @@ -1,172 +1,158 @@ /* - * Copyright (C) 2005-2006 Andre Noll + * Copyright (C) 2005-2013 Andre Noll * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ -/** \file recv.h receiver-relates structures and exported symbols of recv_common.c */ +/** \file recv.h Receiver-related structures and exported symbols of recv_common.c. */ /** - * describes one instance of a receiver + * Describes one instance of a receiver. */ struct receiver_node { - /** points to the corresponding receiver */ + /** Points to the corresponding receiver. */ struct receiver *receiver; - /** the output buffer */ - char *buf; - /** the amount of bytes in \a buf */ - size_t loaded; - /** receiver-specific data */ + /** Receiver-specific data. */ void *private_data; - /** set to 1 if end of file is reached */ - int eof; - /** pointer to the configuration data for this instance */ + /** Pointer to the configuration data for this instance. */ void *conf; + /** The task associated with this instance. */ + 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 + * Describes one supported paraslash receiver. * - * \sa http_recv.c, ortp_recv.c + * \sa http_recv.c, udp_recv.c */ struct receiver { -/** - * - * - * the name of the receiver - */ + /** + * The name of the receiver. + */ const char *name; -/** - * - * - * the receiver init function - * - * It must fill in all other function pointers and is assumed to succeed. - * - * \sa http_recv_init ortp_recv_init - */ + /** + * The receiver init function. + * + * It must fill in all other function pointers and is assumed to succeed. + * + * \sa http_recv_init udp_recv_init. + */ 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); -/** - * - * - * 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). - * - * \sa receiver_node::conf, receiver_node::buf - */ + /** + * 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); + /** + * Deallocate the configuration structure of a receiver node. + * + * This calls the receiver-specific cleanup function generated by + * gengetopt. + */ + void (*free_config)(void *conf); + /** + * 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). + * + * \sa receiver_node::conf, receiver_node::buf. + */ int (*open)(struct receiver_node *rn); -/** - * - * - * close one instance of the receiver - * - * It should free all resources associated with given receiver node that were - * allocated during the corresponding open call. - * - * \sa receiver_node - */ + /** + * Close this instance of the receiver. + * + * It should free all resources associated with given receiver node + * that were allocated during the corresponding open call. + * + * \sa receiver_node. + */ void (*close)(struct receiver_node *rn); -/** - * - * - * deactivate the receiver - * - * Clean up what init has allocated. - */ - void (*shutdown)(void); -/** - * - * - * 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 \a rfds and \a wfds in order to check the result later in the - * post_select hook. - * - * \a timeout is a value-result parameter, initially containing the timeout for - * select() which was set by the application or by another receiver node. If - * the receiver wants its pre_select function to be called at some earlier time - * than the time determined by \a timeout, it may set \a timeout to an - * appropriate smaller value. However, it must never increase this timeout. - * - * This function must return the highest-numbered descriptor it wants to being - * checked, or -1 if no file descriptors should be checked for this run. - * - * \sa select(2), receiver_node:private_data, time.c - */ - int (*pre_select)(struct receiver_node *rn, fd_set *rfds, - fd_set *wfds, struct timeval *timeout); -/** - * - * - * evaluate the result from select() - * - * If the call to select() was succesful, this hook gets called. 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. - * - * A negative return value is interpreted as an error. - * - * \sa select(2), struct receiver - */ - int (*post_select)(struct receiver_node *rn, int select_ret, - fd_set *rfds, fd_set *wfds); -}; + /** + * 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. + * + * \sa select(2), time.c struct task, struct sched. + */ + void (*pre_select)(struct sched *s, struct task *t); + /** + * Evaluate the result from select(). + * + * This hook gets called after the call to select(). It should check + * all file descriptors which were added to any of 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. + * + * \sa select(2), struct receiver. + */ + void (*post_select)(struct sched *s, struct task *t); + /** The two help texts of this receiver. */ + struct ggo_help help; + /** + * Answer a buffer tree query. + * + * This optional function pointer is used for inter node communications + * of the buffer tree nodes. See \ref btr_command_handler for details. + */ + btr_command_handler execute; +}; -/** \cond */ -extern void http_recv_init(struct receiver *r); -#define HTTP_RECEIVER {.name = "http", .init = http_recv_init}, +/** Define an array of all available receivers. */ +#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \ + HTTP_RECEIVER \ + DCCP_RECEIVER \ + UDP_RECEIVER \ + AFH_RECEIVER \ + {.name = NULL}}; -#ifdef HAVE_ORTP -extern void ortp_recv_init(struct receiver *r); -#define ORTP_RECEIVER {.name = "ortp", .init = ortp_recv_init}, -#else -#define ORTP_RECEIVER -#endif +/** Iterate over all available receivers. */ +#define FOR_EACH_RECEIVER(i) for (i = 0; receivers[i].name; 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 receiver */ +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}, +#define AFH_RECEIVER /* not active by default */ extern struct receiver receivers[]; -extern void (*crypt_function_recv)(unsigned long len, const unsigned char *indata, unsigned char *outdata); -extern void (*crypt_function_send)(unsigned long len, const unsigned char *indata, unsigned char *outdata); - -#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \ - HTTP_RECEIVER \ - ORTP_RECEIVER \ - {.name = NULL}}; +/** \endcond receiver */ -/** \endcond */