X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=92b63d27540463034ac7ac8bee970babe4ef5e94;hp=05c5ed7615729219990859d2f953f85b96437c0a;hb=a19ff95e6ec4b76c13446e0687fcf2ae537529ab;hpb=a365b8263a0d7a1673699bdf454677c95b38eb95

diff --git a/recv.h b/recv.h
index 05c5ed76..92b63d27 100644
--- a/recv.h
+++ b/recv.h
@@ -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.
@@ -115,7 +136,7 @@ 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);
@@ -124,5 +145,5 @@ extern void udp_recv_init(struct receiver *r);
 #define UDP_RECEIVER {.name = "udp", .init = udp_recv_init},
 
 extern struct receiver receivers[];
-/** \endcond */
+/** \endcond receiver */