Merge branch 't/recv_improvements'

[paraslash.git] / recv_common.c

diff --git a/recv_common.c b/recv_common.c
index 3fe2a139e0b6a6b270dce5e548e18d76d63ae1aa..53a105dfb107e2feab388fbe29729fa210e6306a 100644 (file)
--- a/recv_common.c
+++ b/recv_common.c
@@ -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);