X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=write.h;h=1361fcf1d052b31596f1407a81cc485b5fa833e1;hb=edeb499676e6d042ef1a913914a9fcb45a8cadde;hp=4a17270990583dfa15fd007ae55dfad92ec9a384;hpb=7d473d0025bc76374f55ca2b135b6e2f70ae4a1e;p=paraslash.git

diff --git a/write.h b/write.h
index 4a172709..1361fcf1 100644
--- a/write.h
+++ b/write.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -39,10 +39,15 @@ struct writer {
 	 * It should check whether the command line options given by \a options are
 	 * valid.  On success, it should return a pointer to the writer-specific
 	 * configuration data determined by \a options.  Note that this might be called
-	 * more than once with different values of \a options.
+	 * more than once with different values of \a options. \sa \ref free_config().
 	 */
 	void *(*parse_config)(const char *options);
-	void (*free_config)(void *conf);
+	/**
+	 * Dellocate all configuration resources.
+	 *
+	 * This should free whatever was allocated by \ref parse_config().
+	 */
+	void (*free_config)(void *config);
 	/**
 	 * Open one instance of this writer.
 	 *
@@ -54,24 +59,16 @@ struct writer {
 	/**
 	 * Prepare the fd sets for select.
 	 *
-	 * This is called from the writer node group task's pre_select(). It
-	 * may use the sched pointer to add any file descriptors or to decrease
-	 * the select timeout. It must return positive on success and negative
-	 * on errors.
+	 * This is called from scheduler. It may use the sched pointer to add
+	 * any file descriptors or to decrease the select timeout.
 	 */
-	int (*pre_select)(struct sched *s, struct writer_node *wn);
-	void (*pre_select_btr)(struct sched *s, struct task *t);
+	void (*pre_select)(struct sched *s, struct task *t);
 	/**
 	 * Write audio data.
 	 *
-	 * Called from the post_select function of the wng task. It must keep
-	 * track of the number of bytes consumed from the wng's buffer via
-	 * the \p wn->written variable (which may be modified by the wng handling
-	 * functions). This function must return positive on success and
-	 * negative on errors.
+	 * Called from the post_select function of the writer node's task.
 	 */
-	int (*post_select)(struct sched *s, struct writer_node *wn);
-	void (*post_select_btr)(struct sched *s, struct task *t);
+	void (*post_select)(struct sched *s, struct task *t);
 	/**
 	 * Close one instance of the writer.
 	 *