string: Clean up for_each_line() and related functions.

[paraslash.git] / recv.h

diff --git a/recv.h b/recv.h
index d6c012b649a545da6c572afbb48a9ec572351b01..f70cbbe8d61d233e6487e1452253162e09a6f6b6 100644 (file)
--- a/recv.h
+++ b/recv.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -12,24 +12,35 @@
 struct receiver_node {
        /** 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. */
        void *private_data;
-       /** 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;
+       /** 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, ortp_recv.c
+ * \sa http_recv.c, udp_recv.c
  */
 struct receiver {
        /**
@@ -41,7 +52,7 @@ struct receiver {
         *
         * It must fill in all other function pointers and is assumed to succeed.
         *
-        * \sa http_recv_init ortp_recv_init.
+        * \sa http_recv_init udp_recv_init.
         */
        void (*init)(struct receiver *r);
        /**
@@ -54,6 +65,13 @@ struct receiver {
         * \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.
         *
@@ -75,12 +93,6 @@ struct receiver {
         * \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).
         *
@@ -96,38 +108,51 @@ struct receiver {
         * 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 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
+        * 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;
 };
 
+/** Define an array of all available receivers. */
+#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \
+       HTTP_RECEIVER \
+       DCCP_RECEIVER \
+       UDP_RECEIVER \
+       AFH_RECEIVER \
+       {.name = NULL}};
 
-/** \cond */
+/** 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},
-
-#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
+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[];
-/** \endcond */
+/** \endcond receiver */
 
-/** Define an array of all available receivers. */
-#define DEFINE_RECEIVER_ARRAY struct receiver receivers[] = { \
-       HTTP_RECEIVER \
-       DCCP_RECEIVER \
-       ORTP_RECEIVER \
-       {.name = NULL}};
-
-void *check_receiver_arg(char *ra, int *receiver_num);