X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv_common.c;h=53a105dfb107e2feab388fbe29729fa210e6306a;hp=6517948d4cd9d1638eed2e50271e46fbce73a62b;hb=6bfdc5bf94294ee8ec19c530d77ea4a0fb4e8618;hpb=5bf80b0268b0afb3984aea74d41eddef34d50d03

diff --git a/recv_common.c b/recv_common.c
index 6517948d..53a105df 100644
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -123,6 +123,19 @@ void print_receiver_helps(int detailed)
 	}
 }
 
+/**
+ * Simple pre-select hook, used by all receivers.
+ *
+ * \param s Scheduler info.
+ * \param t Determines the receiver node.
+ *
+ * This requests a minimal delay from the scheduler if the status of the buffer
+ * tree node indicates an error/eof condition. No file descriptors are added to
+ * the fd sets of \a s.
+ *
+ * \return The status of the btr node of the receiver node, i.e. the return
+ * value of the underlying call to \ref btr_node_status().
+ */
 int generic_recv_pre_select(struct sched *s, struct task *t)
 {
 	struct receiver_node *rn = container_of(t, struct receiver_node, task);