X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv.h;h=f88ebd84897a89df5b748ab86acb399c37917e0a;hp=68978a38c90f2dada11f21d0b55b8a078e4b4bef;hb=9d232e636d79a2321e280fe3eee6839c8f45c36f;hpb=8d106ca317a2c42f35a86ba244f843688f6939e6;ds=sidebyside

diff --git a/recv.h b/recv.h
index 68978a38..f88ebd84 100644
--- a/recv.h
+++ b/recv.h
@@ -1,8 +1,4 @@
-/*
- * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
 /** \file recv.h Receiver-related structures and exported symbols of recv_common.c. */
 
@@ -40,27 +36,23 @@ struct receiver_node {
 /**
  * Describes one supported paraslash receiver.
  *
- * \sa http_recv.c, udp_recv.c
+ * \sa \ref http_recv.c, \ref udp_recv.c.
  */
 struct receiver {
 	/**
 	 * The optional receiver init function.
 	 *
 	 * Performs any initialization needed before the receiver can be opened.
-	 *
-	 * \sa http_recv_init udp_recv_init.
 	 */
 	void (*init)(void);
 	/**
 	 * Open one instance of the receiver.
 	 *
-	 * This should allocate the output buffer of \a rn. and may also
-	 * perform any other work necessary for retrieving the stream according
-	 * to the configuration stored in the \a conf member of \a rn which is
-	 * guaranteed to point to valid configuration data (as previously
-	 * obtained from the config parser).
+	 * This should allocate the output buffer of the given receiver node
+	 * and prepare it for retrieving the audio stream according to the
+	 * configuration stored in rn->lpr.
 	 *
-	 * \sa receiver_node::conf, receiver_node::buf.
+	 * \sa struct \ref receiver_node.
 	 */
 	int (*open)(struct receiver_node *rn);
 	/**
@@ -69,37 +61,38 @@ struct receiver {
 	 * It should free all resources associated with given receiver node
 	 * that were allocated during the corresponding open call.
 	 *
-	 * \sa receiver_node.
+	 * \sa \ref receiver_node.
 	 */
 	void (*close)(struct receiver_node *rn);
 	/**
 	 * Add file descriptors to fd_sets and compute timeout for select(2).
 	 *
-	 * The pre_select function gets called from the driving application
-	 * before entering its select loop. The receiver may use this hook to
-	 * add any file descriptors to the sets of file descriptors given by \a
-	 * s.
+	 * If this is not NULL, the function is called in each iteration of the
+	 * scheduler's select loop. The receiver may define it to add file
+	 * descriptors to the file descriptor sets given by s. Those will be
+	 * monitored in the subsequent call to select(2). The function may also
+	 * lower the timeout value of s to make select(2) return earlier if no
+	 * file descriptors are ready for I/O.
 	 *
-	 * \sa select(2), time.c struct task, struct sched.
+	 * \sa select(2), \ref time.c, struct \ref sched.
 	 */
 	void (*pre_select)(struct sched *s, void *context);
 	/**
-	 * Evaluate the result from select().
+	 * Evaluate the result from select(2).
 	 *
-	 * This hook gets called after the call to select(). It should check
-	 * all file descriptors which were added to any of the fd sets during
-	 * the previous call to pre_select. According to the result, it may
-	 * then use any non-blocking I/O to establish a connection or to
-	 * receive the audio data.
+	 * This is called after the call to select(2). It should check all file
+	 * descriptors which were added to any of the fd sets in the previous
+	 * call to ->pre_select() and perform (non-blocking) I/O operations on
+	 * those fds which are ready for I/O, for example in order to establish
+	 * a connection or to receive a part of the audio stream.
 	 *
-	 * \sa select(2), struct receiver.
+	 * \sa select(2), struct \ref receiver.
 	 */
 	int (*post_select)(struct sched *s, void *context);
-
 	/**
 	 * Answer a buffer tree query.
 	 *
-	 * This optional function pointer is used for inter node communications
+	 * This optional function pointer allows for inter node communication
 	 * of the buffer tree nodes. See \ref btr_command_handler for details.
 	 */
 	btr_command_handler execute;