~mdw
/
disorder
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
TODOs for all the protocol_error() calls that need fixed
[disorder]
/
lib
/
eclient.h
diff --git
a/lib/eclient.h
b/lib/eclient.h
index
c03d9e5
..
1b79cc0
100644
(file)
--- a/
lib/eclient.h
+++ b/
lib/eclient.h
@@
-42,9
+42,13
@@
struct queue_entry;
* These must all be valid.
*/
typedef struct disorder_eclient_callbacks {
* 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
* @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);
*/
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
* @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);
*/
void (*protocol_error)(void *u, void *v, int code, const char *msg);
@@
-141,8
+150,14
@@
struct sink;
typedef void disorder_eclient_no_response(void *v);
/* completion callback with no data */
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);
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 */
typedef void disorder_eclient_integer_response(void *v, long value);
/* completion callback with a integer result */
@@
-344,6
+359,12
@@
int disorder_eclient_edituser(disorder_eclient *c,
const char *property,
const char *value,
void *v);
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
#endif