* This file is part of DisOrder.
* Copyright (C) 2006, 2007 Richard Kettlewell
*
- * This program is free software; you can redistribute it and/or modify
+ * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * General Public License for more details.
- *
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file lib/eclient.h
* @brief Client code for event-driven programs
#ifndef ECLIENT_H
#define ECLIENT_H
+#include "rights.h"
+
/* Asynchronous client interface */
/** @brief Handle type */
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 @p 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);
+
+ /** @brief Called when a track is adopted */
+ void (*adopted)(void *v, const char *id, const char *who);
} disorder_eclient_log_callbacks;
/* State bits */
/** @brief Trivial completion callback
* @param v User data
- * @param error Error string or NULL on succes
+ * @param err Error string or NULL on succes
*/
typedef void disorder_eclient_no_response(void *v,
- const char *error);
+ const char *err);
/** @brief String result completion callback
* @param v User data
- * @param error Error string or NULL on succes
+ * @param err Error string or NULL on succes
* @param value Result or NULL
*
* @p error will be NULL on success. In this case @p value will be the result
* @p error will be non-NULL on failure. In this case @p value is always NULL.
*/
typedef void disorder_eclient_string_response(void *v,
- const char *error,
+ const char *err,
const char *value);
/** @brief String result completion callback
* @param v User data
- * @param error Error string or NULL on succes
+ * @param err Error string or NULL on succes
* @param value Result or 0
*
* @p error will be NULL on success. In this case @p value will be the result.
* @p error will be non-NULL on failure. In this case @p value is always 0.
*/
typedef void disorder_eclient_integer_response(void *v,
- const char *error,
+ const char *err,
long value);
/** @brief Volume completion callback
* @param v User data
- * @param error Error string or NULL on success
+ * @param err Error string or NULL on success
* @param l Left channel volume
* @param r Right channel volume
*
* 0.
*/
typedef void disorder_eclient_volume_response(void *v,
- const char *error,
+ const char *err,
int l, int r);
/** @brief Queue request completion callback
* @param v User data
- * @param error Error string or NULL on success
+ * @param err 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
* be ignored in the error case.
*/
typedef void disorder_eclient_queue_response(void *v,
- const char *error,
+ const char *err,
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 err 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 *err,
+ int nvec, char **vec);
disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
void *u);
const char *password,
const char *rights,
void *v);
-
+void disorder_eclient_enable_connect(disorder_eclient *c);
+void disorder_eclient_disable_connect(disorder_eclient *c);
+int disorder_eclient_adopt(disorder_eclient *c,
+ disorder_eclient_no_response *completed,
+ const char *id,
+ void *v);
#endif
/*