X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv_common.c;h=4f157ab5e6ba6f8fa8623b98e072d17c20395b9a;hp=3fe2a139e0b6a6b270dce5e548e18d76d63ae1aa;hb=4744d937c4160898d1fe151257606430750e580c;hpb=92f089b820b45a5dbdc5b4f69d596105d5acba68

diff --git a/recv_common.c b/recv_common.c
index 3fe2a139..4f157ab5 100644
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2012 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,7 +7,6 @@
 /** \file recv_common.c common functions of para_recv and para_audiod */
 
 #include <regex.h>
-#include <stdbool.h>
 
 #include "para.h"
 #include "list.h"
@@ -123,6 +122,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);