Documentation updates for 0.4.
[paraslash.git] / afs.h
diff --git a/afs.h b/afs.h
index a596317..9e04a7e 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -1,5 +1,5 @@
 /*
 /*
- * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,7 +7,6 @@
 /** \file afs.h Exported symbols of the audio file selector. */
 
 #include <regex.h>
 /** \file afs.h Exported symbols of the audio file selector. */
 
 #include <regex.h>
-#include "osl.h"
 #include "hash.h"
 
 /** Audio file selector data stored in the audio file table. */
 #include "hash.h"
 
 /** Audio file selector data stored in the audio file table. */
@@ -61,14 +60,23 @@ enum afs_events {
        BLOB_REMOVE,
 };
 
        BLOB_REMOVE,
 };
 
+/**
+ * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_ADD.
+ */
 struct rmatt_event_data {
 struct rmatt_event_data {
+       /** The name of the attribute being added. */
        const char *name;
        const char *name;
+       /** Its bit number. */
        unsigned char bitnum;
 };
 
        unsigned char bitnum;
 };
 
-
+/**
+ * Used as data for \ref afs_event() for events of type \p ATTRIBUTE_AFSI_CHANGE.
+ */
 struct afsi_change_event_data {
 struct afsi_change_event_data {
+       /** Pointer to the row that has changed. */
        struct osl_row *aft_row;
        struct osl_row *aft_row;
+       /** Afs info before the change. */
        struct afs_info *old_afsi;
 };
 
        struct afs_info *old_afsi;
 };
 
@@ -87,7 +95,6 @@ struct afs_table {
        /** Handles afs events. */
        int (*event_handler)(enum afs_events event, struct para_buffer *pb,
                void *data);
        /** Handles afs events. */
        int (*event_handler)(enum afs_events event, struct para_buffer *pb,
                void *data);
-       /* int *(check)() */
 };
 
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
 };
 
 enum play_mode {PLAY_MODE_MOOD, PLAY_MODE_PLAYLIST};
@@ -109,16 +116,9 @@ struct ls_data {
        /** The sha1 hash of audio file. */
        HASH_TYPE *hash;
 };
        /** The sha1 hash of audio file. */
        HASH_TYPE *hash;
 };
-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. */
 struct audio_file_data {
 
 /** 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];
        /** The open file descriptor to the current audio file. */
        int fd;
        /** Vss needs this for streaming. */
        /** The open file descriptor to the current audio file. */
        int fd;
        /** Vss needs this for streaming. */
@@ -180,7 +180,7 @@ typedef void callback_function(int fd, const struct osl_object *);
  * \sa \ref send_callback_request().
  */
 typedef int callback_result_handler(struct osl_object *result, void *private);
  * \sa \ref send_callback_request().
  */
 typedef int callback_result_handler(struct osl_object *result, void *private);
-int send_result(struct osl_object *result, void *fd_ptr);
+int rc4_send_result(struct osl_object *result, void *private);
 int pass_buffer_as_shm(char *buf, size_t size, void *fd_ptr);
 
 __noreturn void afs_init(uint32_t cookie, int socket_fd);
 int pass_buffer_as_shm(char *buf, size_t size, void *fd_ptr);
 
 __noreturn void afs_init(uint32_t cookie, int socket_fd);
@@ -196,9 +196,6 @@ int send_option_arg_callback_request(struct osl_object *options,
 int send_standard_callback_request(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, callback_result_handler *result_handler,
-               void *private_result_data);
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 int for_each_matching_row(struct pattern_match_data *pmd);
 
 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2);
 int for_each_matching_row(struct pattern_match_data *pmd);