Send clients a rights-changed message when their rights change.

[disorder] / lib / eclient.h

diff --git a/lib/eclient.h b/lib/eclient.h
index e37dda9f51e8c363364912706eee688d5c3e4ec8..be5730cb5eb19367bf71f9ce361de320f0c1dacb 100644 (file)
--- a/lib/eclient.h
+++ b/lib/eclient.h
@@ -24,6 +24,8 @@
 #ifndef ECLIENT_H
 #define ECLIENT_H
 
+#include "rights.h"
+
 /* Asynchronous client interface */
 
 /** @brief Handle type */
@@ -93,19 +95,78 @@ typedef struct disorder_eclient_callbacks {
 typedef struct disorder_eclient_log_callbacks {
   /** @brief Called on (re-)connection */
   void (*connected)(void *v);
-  
+
+  /** @brief Called when @p track finished playing successfully */
   void (*completed)(void *v, const char *track);
+
+  /** @brief Called when @p track fails for some reason */
   void (*failed)(void *v, const char *track, const char *status);
+
+  /** @brief Called when @p user moves some track or tracks in the queue
+   *
+   * Fetch the queue again to find out what the new order is - the
+   * rearrangement could in principle be arbitrarily complicated.
+   */
   void (*moved)(void *v, const char *user);
+
+  /** @brief Called when @p track starts playing
+   *
+   * @p user might be 0.
+   */
   void (*playing)(void *v, const char *track, const char *user/*maybe 0*/);
+
+  /** @brief Called when @p q is added to the queue
+   *
+   * Fetch the queue again to find out where the in the queue it was added.
+   */   
   void (*queue)(void *v, struct queue_entry *q);
+
+  /** @brief Called when @p q is added to the recent list */
   void (*recent_added)(void *v, struct queue_entry *q);
+
+  /** @brief Called when @p id is removed from the recent list */
   void (*recent_removed)(void *v, const char *id);
+
+  /** @brief Called when @id is removed from the queue
+   *
+   * @p user might be 0.
+   */
   void (*removed)(void *v, const char *id, const char *user/*maybe 0*/);
+
+  /** @brief Called when @p track is scratched */
   void (*scratched)(void *v, const char *track, const char *user);
+
+  /** @brief Called with the current state whenever it changes
+   *
+   * State bits are:
+   * - @ref DISORDER_PLAYING_ENABLED
+   * - @ref DISORDER_RANDOM_ENABLED
+   * - @ref DISORDER_TRACK_PAUSED
+   * - @ref DISORDER_PLAYING
+   * - @ref DISORDER_CONNECTED
+   */
   void (*state)(void *v, unsigned long state);
+
+  /** @brief Called when the volume changes */
   void (*volume)(void *v, int left, int right);
+
+  /** @brief Called when a rescan completes */
   void (*rescanned)(void *v);
+
+  /** @brief Called when a user is created (admins only) */
+  void (*user_add)(void *v, const char *user);
+
+  /** @brief Called when a user is confirmed (admins only) */
+  void (*user_confirm)(void *v, const char *user);
+
+  /** @brief Called when a user is deleted (admins only) */
+  void (*user_delete)(void *v, const char *user);
+
+  /** @brief Called when a user is edited (admins only) */
+  void (*user_edit)(void *v, const char *user, const char *property);
+
+  /** @brief Called when your rights change */
+  void (*rights_changed)(void *v, rights_type new_rights);
 } disorder_eclient_log_callbacks;
 
 /* State bits */
@@ -201,8 +262,8 @@ typedef void disorder_eclient_volume_response(void *v,
  * @param error Error string or NULL on success
  * @param q Head of queue data list
  *
- * @p error will be NULL on success.  In this case @p q be the (head of the)
- * result.
+ * @p error will be NULL on success.  In this case @p q will be the (head of
+ * the) result.
  *
  * @p error will be non-NULL on failure.  In this case @p q may be NULL but
  * MIGHT also be some subset of the queue.  For consistent behavior it should
@@ -212,8 +273,21 @@ typedef void disorder_eclient_queue_response(void *v,
                                              const char *error,
                                              struct queue_entry *q);
 
-typedef void disorder_eclient_list_response(void *v, int nvec, char **vec);
-/* completion callback for file listing etc */
+/** @brief List request completion callback
+ * @param v User data
+ * @param error Error string or NULL on success
+ * @param nvec Number of elements in response list
+ * @param vec Pointer to response list
+ *
+ * @p error will be NULL on success.  In this case @p nvec and @p vec will give
+ * the result.
+ *
+ * @p error will be non-NULL on failure.  In this case @p nvec and @p vec will
+ * be 0 and NULL.
+ */
+typedef void disorder_eclient_list_response(void *v,
+                                            const char *error,
+                                            int nvec, char **vec);
 
 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
                                        void *u);