2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/eclient.h
21 * @brief Client code for event-driven programs
27 /* Asynchronous client interface */
29 /** @brief Handle type */
30 typedef struct disorder_eclient disorder_eclient;
34 /** @brief Set to read from the FD */
35 #define DISORDER_POLL_READ 1u
37 /** @brief Set to write to the FD */
38 #define DISORDER_POLL_WRITE 2u
40 /** @brief Callbacks for all clients
42 * These must all be valid.
44 typedef struct disorder_eclient_callbacks {
45 /** @brief Called when a communication error occurs.
46 * @param u from disorder_eclient_new()
47 * @param msg error message
49 * This might be called at any time, and indicates a low-level error,
50 * e.g. connection refused by the server. It does not mean that any requests
51 * made of the owning eclient will not be fulfilled at some point.
53 void (*comms_error)(void *u, const char *msg);
55 /** @brief Called when a command fails (including initial authorization).
56 * @param u from disorder_eclient_new()
57 * @param v from failed command, or NULL if during setup
58 * @param msg error message
60 * This call is obsolete at least in its current form, in which it is used to
61 * report most errors from most requests. Ultimately requests-specific
62 * errors will be reported in a request-specific way rather than via this
65 void (*protocol_error)(void *u, void *v, int code, const char *msg);
67 /** @brief Set poll/select flags
68 * @param u from disorder_eclient_new()
70 * @param fd file descriptor
71 * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE)
73 * Before @p fd is closed you will always get a call with @p mode = 0.
75 void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode);
77 /** @brief Report current activity
78 * @param u from disorder_eclient_new()
79 * @param msg Current activity or NULL
81 * Called with @p msg = NULL when there's nothing going on.
83 void (*report)(void *u, const char *msg);
84 } disorder_eclient_callbacks;
86 /** @brief Callbacks for log clients
88 * All of these are allowed to be a null pointers in which case you don't get
89 * told about that log event.
91 * See disorder_protocol(5) for full documentation.
93 typedef struct disorder_eclient_log_callbacks {
94 /** @brief Called on (re-)connection */
95 void (*connected)(void *v);
97 void (*completed)(void *v, const char *track);
98 void (*failed)(void *v, const char *track, const char *status);
99 void (*moved)(void *v, const char *user);
100 void (*playing)(void *v, const char *track, const char *user/*maybe 0*/);
101 void (*queue)(void *v, struct queue_entry *q);
102 void (*recent_added)(void *v, struct queue_entry *q);
103 void (*recent_removed)(void *v, const char *id);
104 void (*removed)(void *v, const char *id, const char *user/*maybe 0*/);
105 void (*scratched)(void *v, const char *track, const char *user);
106 void (*state)(void *v, unsigned long state);
107 void (*volume)(void *v, int left, int right);
108 void (*rescanned)(void *v);
109 } disorder_eclient_log_callbacks;
113 /** @brief Play is enabled */
114 #define DISORDER_PLAYING_ENABLED 0x00000001
116 /** @brief Random play is enabled */
117 #define DISORDER_RANDOM_ENABLED 0x00000002
119 /** @brief Track is paused
121 * This is only meaningful if @ref DISORDER_PLAYING is set
123 #define DISORDER_TRACK_PAUSED 0x00000004
125 /** @brief Track is playing
127 * This can be set even if the current track is paused (in which case @ref
128 * DISORDER_TRACK_PAUSED) will also be set.
130 #define DISORDER_PLAYING 0x00000008
132 /** @brief Connected to server
134 * By connected it is meant that commands have a reasonable chance of being
135 * processed soon, not merely that a TCP connection exists - for instance if
136 * the client is still authenticating then that does not count as connected.
138 #define DISORDER_CONNECTED 0x00000010
140 char *disorder_eclient_interpret_state(unsigned long statebits);
146 /* Completion callbacks. These provide the result of operations to the caller.
147 * Unlike in earlier releases, these are not allowed to be NULL. */
149 /** @brief Trivial completion callback
151 * @param error Error string or NULL on succes
153 typedef void disorder_eclient_no_response(void *v,
156 /** @brief String result completion callback
158 * @param error Error string or NULL on succes
159 * @param value Result or NULL
161 * @p error will be NULL on success. In this case @p value will be the result
162 * (which might be NULL for disorder_eclient_get(),
163 * disorder_eclient_get_global() and disorder_eclient_userinfo()).
165 * @p error will be non-NULL on failure. In this case @p value is always NULL.
167 typedef void disorder_eclient_string_response(void *v,
171 /** @brief String result completion callback
173 * @param error Error string or NULL on succes
174 * @param value Result or 0
176 * @p error will be NULL on success. In this case @p value will be the result.
178 * @p error will be non-NULL on failure. In this case @p value is always 0.
180 typedef void disorder_eclient_integer_response(void *v,
183 /** @brief Volume completion callback
185 * @param error Error string or NULL on success
186 * @param l Left channel volume
187 * @param r Right channel volume
189 * @p error will be NULL on success. In this case @p l and @p r will be the
192 * @p error will be non-NULL on failure. In this case @p l and @p r are always
195 typedef void disorder_eclient_volume_response(void *v,
199 /** @brief Queue request completion callback
201 * @param error Error string or NULL on success
202 * @param q Head of queue data list
204 * @p error will be NULL on success. In this case @p q be the (head of the)
207 * @p error will be non-NULL on failure. In this case @p q may be NULL but
208 * MIGHT also be some subset of the queue. For consistent behavior it should
209 * be ignored in the error case.
211 typedef void disorder_eclient_queue_response(void *v,
213 struct queue_entry *q);
215 typedef void disorder_eclient_list_response(void *v, int nvec, char **vec);
216 /* completion callback for file listing etc */
218 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
220 /* Create a new client */
222 void disorder_eclient_close(disorder_eclient *c);
225 unsigned long disorder_eclient_state(const disorder_eclient *c);
227 void disorder_eclient_polled(disorder_eclient *c, unsigned mode);
228 /* Should be called when c's FD is readable and/or writable, and in any case
229 * from time to time (so that retries work). */
231 int disorder_eclient_version(disorder_eclient *c,
232 disorder_eclient_string_response *completed,
234 /* fetch the server version */
236 int disorder_eclient_play(disorder_eclient *c,
238 disorder_eclient_no_response *completed,
240 /* add a track to the queue */
242 int disorder_eclient_pause(disorder_eclient *c,
243 disorder_eclient_no_response *completed,
245 /* add a track to the queue */
247 int disorder_eclient_resume(disorder_eclient *c,
248 disorder_eclient_no_response *completed,
250 /* add a track to the queue */
252 int disorder_eclient_scratch(disorder_eclient *c,
254 disorder_eclient_no_response *completed,
256 /* scratch a track by ID */
258 int disorder_eclient_scratch_playing(disorder_eclient *c,
259 disorder_eclient_no_response *completed,
261 /* scratch the playing track whatever it is */
263 int disorder_eclient_remove(disorder_eclient *c,
265 disorder_eclient_no_response *completed,
267 /* remove a track from the queue */
269 int disorder_eclient_moveafter(disorder_eclient *c,
273 disorder_eclient_no_response *completed,
275 /* move tracks within the queue */
277 int disorder_eclient_playing(disorder_eclient *c,
278 disorder_eclient_queue_response *completed,
280 /* find the currently playing track (0 for none) */
282 int disorder_eclient_queue(disorder_eclient *c,
283 disorder_eclient_queue_response *completed,
285 /* list recently played tracks */
287 int disorder_eclient_recent(disorder_eclient *c,
288 disorder_eclient_queue_response *completed,
290 /* list recently played tracks */
292 int disorder_eclient_files(disorder_eclient *c,
293 disorder_eclient_list_response *completed,
297 /* list files in a directory, matching RE if not a null pointer */
299 int disorder_eclient_dirs(disorder_eclient *c,
300 disorder_eclient_list_response *completed,
304 /* list directories in a directory, matching RE if not a null pointer */
306 int disorder_eclient_namepart(disorder_eclient *c,
307 disorder_eclient_string_response *completed,
312 /* look up a track name part */
314 int disorder_eclient_length(disorder_eclient *c,
315 disorder_eclient_integer_response *completed,
318 /* look up a track name length */
320 int disorder_eclient_volume(disorder_eclient *c,
321 disorder_eclient_volume_response *callback,
324 /* If L and R are both -ve gets the volume.
325 * If neither are -ve then sets the volume.
329 int disorder_eclient_enable(disorder_eclient *c,
330 disorder_eclient_no_response *callback,
332 int disorder_eclient_disable(disorder_eclient *c,
333 disorder_eclient_no_response *callback,
335 int disorder_eclient_random_enable(disorder_eclient *c,
336 disorder_eclient_no_response *callback,
338 int disorder_eclient_random_disable(disorder_eclient *c,
339 disorder_eclient_no_response *callback,
341 /* Enable/disable play/random play */
343 int disorder_eclient_resolve(disorder_eclient *c,
344 disorder_eclient_string_response *completed,
347 /* Resolve aliases */
349 int disorder_eclient_log(disorder_eclient *c,
350 const disorder_eclient_log_callbacks *callbacks,
352 /* Make this a log client (forever - it automatically becomes one again upon
355 int disorder_eclient_get(disorder_eclient *c,
356 disorder_eclient_string_response *completed,
357 const char *track, const char *pref,
359 int disorder_eclient_set(disorder_eclient *c,
360 disorder_eclient_no_response *completed,
361 const char *track, const char *pref,
364 int disorder_eclient_unset(disorder_eclient *c,
365 disorder_eclient_no_response *completed,
366 const char *track, const char *pref,
368 /* Get/set preference values */
370 int disorder_eclient_search(disorder_eclient *c,
371 disorder_eclient_list_response *completed,
375 int disorder_eclient_nop(disorder_eclient *c,
376 disorder_eclient_no_response *completed,
379 int disorder_eclient_new_tracks(disorder_eclient *c,
380 disorder_eclient_list_response *completed,
384 int disorder_eclient_rtp_address(disorder_eclient *c,
385 disorder_eclient_list_response *completed,
388 int disorder_eclient_users(disorder_eclient *c,
389 disorder_eclient_list_response *completed,
391 int disorder_eclient_deluser(disorder_eclient *c,
392 disorder_eclient_no_response *completed,
395 int disorder_eclient_userinfo(disorder_eclient *c,
396 disorder_eclient_string_response *completed,
398 const char *property,
400 int disorder_eclient_edituser(disorder_eclient *c,
401 disorder_eclient_no_response *completed,
403 const char *property,
406 int disorder_eclient_adduser(disorder_eclient *c,
407 disorder_eclient_no_response *completed,
409 const char *password,