/*
* This file is part of DisOrder.
- * Copyright (C) 2006 Richard Kettlewell
+ * Copyright (C) 2006, 2007 Richard Kettlewell
*
* 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
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
+/** @file lib/eclient.h
+ * @brief Client code for event-driven programs
+ */
#ifndef ECLIENT_H
#define ECLIENT_H
/* Asynchronous client interface */
+/** @brief Handle type */
typedef struct disorder_eclient disorder_eclient;
struct queue_entry;
-#define DISORDER_POLL_READ 1u /* want to read FD */
-#define DISORDER_POLL_WRITE 2u /* want to write FD */
+/** @brief Set to read from the FD */
+#define DISORDER_POLL_READ 1u
+
+/** @brief Set to write to the FD */
+#define DISORDER_POLL_WRITE 2u
-/* Callbacks for all clients. These must all be valid. */
+/** @brief Callbacks for all clients
+ *
+ * These must all be valid.
+ */
typedef struct disorder_eclient_callbacks {
+ /** @brief Called when a communication error (e.g. connected refused) occurs.
+ * @param u from disorder_eclient_new()
+ * @param msg error message
+ */
void (*comms_error)(void *u, const char *msg);
- /* Called when a communication error (e.g. connected refused) occurs. U
- * comes from the _new() call and MSG describes the problem.*/
+ /** @brief Called when a command fails (including initial authorization).
+ * @param u from disorder_eclient_new()
+ * @param v from failed command, or NULL if during setup
+ * @param msg error message
+ */
void (*protocol_error)(void *u, void *v, int code, const char *msg);
- /* Called when a command fails (including initial authorization). U comes
- * from the _new() call, V from the failed command or a null pointer if the
- * error is in setup and MSG describes the problem. */
-
+
+ /** @brief Set poll/select flags
+ * @param u from disorder_eclient_new()
+ * @param c handle
+ * @param fd file descriptor
+ * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE)
+ *
+ * Before @p fd is closed you will always get a call with @p mode = 0.
+ */
void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode);
- /* Set poll/select flags for FD according to MODE. FD will never be -1.
- * Before FD is closed, you will always get a call with MODE=0. U comes from
- * the _new() call. */
+ /** @brief Report current activity
+ * @param u from disorder_eclient_new()
+ * @param msg Current activity or NULL
+ *
+ * Called with @p msg = NULL when there's nothing going on.
+ */
void (*report)(void *u, const char *msg);
- /* Called from time to time to report what's doing. Called with MSG=0
- * when the client goes idle.*/
} disorder_eclient_callbacks;
-/* Callbacks for log clients. All of these are allowed to be a null pointers
- * in which case you don't get told about that log event. */
+/** @brief Callbacks for log clients
+ *
+ * All of these are allowed to be a null pointers in which case you don't get
+ * told about that log event.
+ *
+ * See disorder_protocol(5) for full documentation.
+ */
typedef struct disorder_eclient_log_callbacks {
+ /** @brief Called on (re-)connection */
void (*connected)(void *v);
- /* Called on (re-)connection */
-
- /* See disorder_protocol(5) for documentation for the rest */
void (*completed)(void *v, const char *track);
void (*failed)(void *v, const char *track, const char *status);
void (*scratched)(void *v, const char *track, const char *user);
void (*state)(void *v, unsigned long state);
void (*volume)(void *v, int left, int right);
+ void (*rescanned)(void *v);
} disorder_eclient_log_callbacks;
/* State bits */
-#define DISORDER_PLAYING_ENABLED 0x00000001 /* play is enabled */
-#define DISORDER_RANDOM_ENABLED 0x00000002 /* random play is enabled */
-#define DISORDER_TRACK_PAUSED 0x00000004 /* track is paused */
+
+/** @brief Play is enabled */
+#define DISORDER_PLAYING_ENABLED 0x00000001
+
+/** @brief Random play is enabled */
+#define DISORDER_RANDOM_ENABLED 0x00000002
+
+/** @brief Track is paused
+ *
+ * This is only meaningful if @ref DISORDER_PLAYING is set
+ */
+#define DISORDER_TRACK_PAUSED 0x00000004
+
+/** @brief Track is playing
+ *
+ * This can be set even if the current track is paused (in which case @ref
+ * DISORDER_TRACK_PAUSED) will also be set.
+ */
+#define DISORDER_PLAYING 0x00000008
+
+/** @brief Connected to server
+ *
+ * By connected it is meant that commands have a reasonable chance of being
+ * processed soon, not merely that a TCP connection exists - for instance if
+ * the client is still authenticating then that does not count as connected.
+ */
+#define DISORDER_CONNECTED 0x00000010
+
+char *disorder_eclient_interpret_state(unsigned long statebits);
struct queue_entry;
struct kvp;
typedef void disorder_eclient_no_response(void *v);
/* completion callback with no data */
+/** @brief String result completion callback
+ * @param v User data
+ * @param value or NULL
+ *
+ * @p value can be NULL for disorder_eclient_get(),
+ * disorder_eclient_get_global() and disorder_eclient_userinfo().
+ */
typedef void disorder_eclient_string_response(void *v, const char *value);
-/* completion callback with a string result */
typedef void disorder_eclient_integer_response(void *v, long value);
/* completion callback with a integer result */
void disorder_eclient_close(disorder_eclient *c);
/* Close C */
+unsigned long disorder_eclient_state(const disorder_eclient *c);
+
void disorder_eclient_polled(disorder_eclient *c, unsigned mode);
/* Should be called when c's FD is readable and/or writable, and in any case
* from time to time (so that retries work). */
const char *terms,
void *v);
+int disorder_eclient_nop(disorder_eclient *c,
+ disorder_eclient_no_response *completed,
+ void *v);
+
+int disorder_eclient_new_tracks(disorder_eclient *c,
+ disorder_eclient_list_response *completed,
+ int max,
+ void *v);
+
+int disorder_eclient_rtp_address(disorder_eclient *c,
+ disorder_eclient_list_response *completed,
+ void *v);
+
+int disorder_eclient_users(disorder_eclient *c,
+ disorder_eclient_list_response *completed,
+ void *v);
+int disorder_eclient_deluser(disorder_eclient *c,
+ disorder_eclient_no_response *completed,
+ const char *user,
+ void *v);
+int disorder_eclient_userinfo(disorder_eclient *c,
+ disorder_eclient_string_response *completed,
+ const char *user,
+ const char *property,
+ void *v);
+int disorder_eclient_edituser(disorder_eclient *c,
+ disorder_eclient_no_response *completed,
+ const char *user,
+ const char *property,
+ const char *value,
+ void *v);
+int disorder_eclient_adduser(disorder_eclient *c,
+ disorder_eclient_no_response *completed,
+ const char *user,
+ const char *password,
+ const char *rights,
+ void *v);
+
#endif
/*
~mdw / disorder / blobdiff