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

diff --git a/recv.h b/recv.h
index ee8138f9..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;
 };
 
 /**
@@ -121,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);
@@ -130,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 */