X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=f70cbbe8d61d233e6487e1452253162e09a6f6b6;hp=271932b183a3101f147273332d4e592c49bd09d7;hb=23b121a85984baa9252f4b4c0b8c4f186e394bb7;hpb=8d5053bf55b02b106cef1cfcce9fc30d9a248b89

diff --git a/recv.h b/recv.h
index 271932b1..f70cbbe8 100644
--- a/recv.h
+++ b/recv.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -20,6 +20,21 @@ struct receiver_node {
 	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;
 };
 
 /**
@@ -50,6 +65,12 @@ 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.
@@ -87,9 +108,9 @@ 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.
@@ -98,6 +119,13 @@ struct receiver {
 
 	/** 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. */
@@ -105,6 +133,7 @@ struct receiver {
 	HTTP_RECEIVER \
 	DCCP_RECEIVER \
 	UDP_RECEIVER \
+	AFH_RECEIVER \
 	{.name = NULL}};
 
 /** Iterate over all available receivers. */
@@ -115,14 +144,15 @@ 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 */
+/** \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[];
-/** \endcond */
+/** \endcond receiver */