* 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);
* @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);
* 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 */
+/** @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);
/** @brief String result completion callback
* @param v User data
- * @param value or NULL
+ * @param error Error string or NULL on succes
+ * @param value or NULL if not found
*
- * @p value can be NULL for disorder_eclient_get(),
- * disorder_eclient_get_global() and disorder_eclient_userinfo().
+ * @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 *value);
+typedef void disorder_eclient_string_response(void *v,
+ const char *error,
+ const char *value);
typedef void disorder_eclient_integer_response(void *v, long value);
/* completion callback with a integer result */
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