X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=d52cebaaf15a06e7bf8de9d13b22d03569e382d3;hp=f7fc7259b17a3d1210fe65a9c8d874638d1948f5;hb=190eec54bed8fe79e0ccd72614b253d591e76b4f;hpb=1f556ae88bd8c85d4452f689f532f5a6abeabe92 diff --git a/recv.h b/recv.h index f7fc7259..d52cebaa 100644 --- a/recv.h +++ b/recv.h @@ -1,22 +1,10 @@ /* - * Copyright (C) 2005-2006 Andre Noll + * Copyright (C) 2005-2008 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 @@ -30,10 +18,12 @@ struct receiver_node { size_t loaded; /** receiver-specific data */ void *private_data; - /** set to 1 if end of file is reached */ - int eof; + /** Pointer to the error member of the consumer. */ + int *output_error; /** pointer to the configuration data for this instance */ void *conf; + /** the task associated with this instance */ + struct task task; }; /** @@ -43,14 +33,10 @@ struct receiver_node { */ struct 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. @@ -59,8 +45,6 @@ struct receiver { */ 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 @@ -68,12 +52,9 @@ struct receiver { * 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 @@ -86,9 +67,7 @@ struct receiver { */ int (*open)(struct receiver_node *rn); /** - * - * - * close one instance of the receiver + * close this instance of the receiver * * It should free all resources associated with given receiver node that were * allocated during the corresponding open call. @@ -97,52 +76,32 @@ struct receiver { */ 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. + * descriptors to the sets of file descriptors given by \a s. * - * 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 + * \sa select(2), time.c struct task, struct sched */ - int (*pre_select)(struct receiver_node *rn, fd_set *rfds, - fd_set *wfds, struct timeval *timeout); + void (*pre_select)(struct sched *s, struct task *t); /** - * - * * 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. + * 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. * * \sa select(2), struct receiver */ - int (*post_select)(struct receiver_node *rn, int select_ret, - fd_set *rfds, fd_set *wfds); + void (*post_select)(struct sched *s, struct task *t); }; @@ -159,17 +118,14 @@ extern void ortp_recv_init(struct receiver *r); #define ORTP_RECEIVER #endif -void *check_receiver_arg(char *ra, int *receiver_num); - - 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); +/** \endcond */ +/** define an array of all available receivers */ #define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \ HTTP_RECEIVER \ DCCP_RECEIVER \ ORTP_RECEIVER \ {.name = NULL}}; -/** \endcond */ +void *check_receiver_arg(char *ra, int *receiver_num);