fix doxygen comment of the init functions of all audio format handlers.

[paraslash.git] / recv.h

diff --git a/recv.h b/recv.h
index f7fc7259b17a3d1210fe65a9c8d874638d1948f5..63624b6a7bab31c2efda9f5f4f3e0d896456c56f 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     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
@@ -16,7 +16,7 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
-/** \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
@@ -32,8 +32,12 @@ struct receiver_node {
        void *private_data;
        /** set to 1 if end of file is reached */
        int eof;
+       /** pointer to the eof member of the consumer */
+       int *output_eof;
        /** pointer to the configuration data for this instance */
        void *conf;
+       /** the task associated with this instance */
+       struct task task;
 };
 
 /**
@@ -43,14 +47,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 +59,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 +66,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 +81,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 +90,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.
- *
- * 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.
+ * descriptors to the sets of file descriptors given by \a s.
  *
- * \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 +132,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);