struct sink;
/* Completion callbacks. These provide the result of operations to the caller.
- * It is always allowed for these to be null pointers if you don't care about
- * the result. */
+ * Unlike in earlier releases, these are not allowed to be NULL. */
/** @brief Trivial completion callback
* @param v User data
typedef void disorder_eclient_integer_response(void *v,
const char *error,
long value);
-/* completion callback with a integer result */
-
-typedef void disorder_eclient_volume_response(void *v, int l, int r);
-/* completion callback with a pair of integer results */
+/** @brief Volume completion callback
+ * @param v User data
+ * @param error Error string or NULL on success
+ * @param l Left channel volume
+ * @param r Right channel volume
+ *
+ * @p error will be NULL on success. In this case @p l and @p r will be the
+ * result.
+ *
+ * @p error will be non-NULL on failure. In this case @p l and @p r are always
+ * 0.
+ */
+typedef void disorder_eclient_volume_response(void *v,
+ const char *error,
+ int l, int r);
-typedef void disorder_eclient_queue_response(void *v, struct queue_entry *q);
-/* completion callback for queue/recent listing */
+/** @brief Queue request completion callback
+ * @param v User data
+ * @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 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
+ * be ignored in the error case.
+ */
+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);