X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.h;h=569798457b1338bd3261883557549a0b0129de02;hp=4c171a8e08f2d3c91c1055363c9a457d09d98b30;hb=0a3b9b83;hpb=2bc092485c67b68d81cc29643d3e8a764d1a26a0

diff --git a/afs.h b/afs.h
index 4c171a8e..56979845 100644
--- a/afs.h
+++ b/afs.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -110,11 +110,10 @@ struct ls_data {
 int make_status_items(struct ls_data *d, struct para_buffer *pb);
 void make_empty_status_items(char *buf);
 
+/** At most that many bytes will be passed from afs to para_server. */
 #define VERBOSE_LS_OUTPUT_SIZE 4096
 
-/*
- * Data about the current audio file, passed from afs to server.
- */
+/** Data about the current audio file, passed from afs to server. */
 struct audio_file_data {
 	/** Same info as ls -lv -p current audio_file. */
 	char verbose_ls_output[VERBOSE_LS_OUTPUT_SIZE];
@@ -161,21 +160,35 @@ struct pattern_match_data {
 };
 
 /* afs */
+/**
+ * Afs command handlers run as a process which is not related to the afs
+ * process, i.e. they can not change the address space of afs directly.
+ * Therefore afs commands typically consist of two functions: The command
+ * handler and the corresponding callback function that runs in afs context.
+ *
+ * \sa send_callback_request().
+ */
 typedef int callback_function(const struct osl_object *, struct osl_object *);
+typedef int callback_result_handler(struct osl_object *result, void *private);
+int send_result(struct osl_object *result, void *private_result_data);
+
 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 void afs_event(enum afs_events event, struct para_buffer *pb,
 	void *data);
 int send_callback_request(callback_function *f, struct osl_object *query,
-	struct osl_object *result);
-int send_standard_callback_request(int argc, char * const * const argv,
-		callback_function *f, struct osl_object *result);
+		callback_result_handler *result_handler,
+		void *private_result_data);
 int send_option_arg_callback_request(struct osl_object *options,
-	int argc, char * const * const argv, callback_function *f,
-	struct osl_object *result);
+		int argc,  char * const * const argv, callback_function *f,
+		callback_result_handler *result_handler,
+		void *private_result_data);
+int send_standard_callback_request(int argc,  char * const * const argv,
+		callback_function *f, callback_result_handler *result_handler,
+		void *private_result_data);
 int stdin_command(int fd, struct osl_object *arg_obj, callback_function *f,
-		unsigned max_len, struct osl_object *result);
+		unsigned max_len, callback_result_handler *result_handler,
+		void *private_result_data);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
-int close_audio_file(struct audio_file_data *afd);
 int for_each_matching_row(struct pattern_match_data *pmd);
 
 /* score */