X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/ad58ebcc8a950f4624cfb1a836e18a703c3b6610..658c8a359409a339d71910f68452bfaa751734c0:/lib/eclient.h diff --git a/lib/eclient.h b/lib/eclient.h index d1e4e97..1b47dff 100644 --- a/lib/eclient.h +++ b/lib/eclient.h @@ -1,6 +1,6 @@ /* * 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 @@ -42,9 +42,13 @@ struct queue_entry; * These must all be valid. */ typedef struct disorder_eclient_callbacks { - /** @brief Called when a communication error (e.g. connected refused) occurs. + /** @brief Called when a communication error occurs. * @param u from disorder_eclient_new() * @param msg error message + * + * This might be called at any time, and indicates a low-level error, + * e.g. connection refused by the server. It does not mean that any requests + * made of the owning eclient will not be fulfilled at some point. */ void (*comms_error)(void *u, const char *msg); @@ -52,6 +56,11 @@ typedef struct disorder_eclient_callbacks { * @param u from disorder_eclient_new() * @param v from failed command, or NULL if during setup * @param msg error message + * + * This call is obsolete at least in its current form, in which it is used to + * report most errors from most requests. Ultimately requests-specific + * errors will be reported in a request-specific way rather than via this + * generic callback. */ void (*protocol_error)(void *u, void *v, int code, const char *msg); @@ -96,6 +105,7 @@ typedef struct disorder_eclient_log_callbacks { 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 */ @@ -106,9 +116,29 @@ typedef struct disorder_eclient_log_callbacks { /** @brief Random play is enabled */ #define DISORDER_RANDOM_ENABLED 0x00000002 -/** @brief Track is paused */ +/** @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; struct sink; @@ -117,13 +147,40 @@ struct sink; * It is always allowed for these to be null pointers if you don't care about * the result. */ -typedef void disorder_eclient_no_response(void *v); -/* completion callback with no data */ - -typedef void disorder_eclient_string_response(void *v, const char *value); -/* completion callback with a string result */ +/** @brief Trivial completion callback + * @param v User data + * @param error Error string or NULL on succes + */ +typedef void disorder_eclient_no_response(void *v, + const char *error); -typedef void disorder_eclient_integer_response(void *v, long value); +/** @brief String result completion callback + * @param v User data + * @param error 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 + * (which might be NULL for disorder_eclient_get(), + * disorder_eclient_get_global() and disorder_eclient_userinfo()). + * + * @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 *value); + +/** @brief String result completion callback + * @param v User data + * @param error 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, + long value); /* completion callback with a integer result */ typedef void disorder_eclient_volume_response(void *v, int l, int r); @@ -142,7 +199,7 @@ disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb, void disorder_eclient_close(disorder_eclient *c); /* Close C */ -int disorder_eclient_connected(const disorder_eclient *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 @@ -292,6 +349,44 @@ int disorder_eclient_search(disorder_eclient *c, 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 /*