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 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU 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, see <http://www.gnu.org/licenses/>.
18 /** @file lib/eclient.h
19 * @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 /** @brief Called when @p track finished playing successfully */
98 void (*completed
)(void *v
, const char *track
);
100 /** @brief Called when @p track fails for some reason */
101 void (*failed
)(void *v
, const char *track
, const char *status
);
103 /** @brief Called when @p user moves some track or tracks in the queue
105 * Fetch the queue again to find out what the new order is - the
106 * rearrangement could in principle be arbitrarily complicated.
108 void (*moved
)(void *v
, const char *user
);
110 /** @brief Called when @p track starts playing
112 * @p user might be 0.
114 void (*playing
)(void *v
, const char *track
, const char *user
/*maybe 0*/);
116 /** @brief Called when @p q is added to the queue
118 * Fetch the queue again to find out where the in the queue it was added.
120 void (*queue
)(void *v
, struct queue_entry
*q
);
122 /** @brief Called when @p q is added to the recent list */
123 void (*recent_added
)(void *v
, struct queue_entry
*q
);
125 /** @brief Called when @p id is removed from the recent list */
126 void (*recent_removed
)(void *v
, const char *id
);
128 /** @brief Called when @p id is removed from the queue
130 * @p user might be 0.
132 void (*removed
)(void *v
, const char *id
, const char *user
/*maybe 0*/);
134 /** @brief Called when @p track is scratched */
135 void (*scratched
)(void *v
, const char *track
, const char *user
);
137 /** @brief Called with the current state whenever it changes
140 * - @ref DISORDER_PLAYING_ENABLED
141 * - @ref DISORDER_RANDOM_ENABLED
142 * - @ref DISORDER_TRACK_PAUSED
143 * - @ref DISORDER_PLAYING
144 * - @ref DISORDER_CONNECTED
146 void (*state
)(void *v
, unsigned long state
);
148 /** @brief Called when the volume changes */
149 void (*volume
)(void *v
, int left
, int right
);
151 /** @brief Called when a rescan completes */
152 void (*rescanned
)(void *v
);
154 /** @brief Called when a user is created (admins only) */
155 void (*user_add
)(void *v
, const char *user
);
157 /** @brief Called when a user is confirmed (admins only) */
158 void (*user_confirm
)(void *v
, const char *user
);
160 /** @brief Called when a user is deleted (admins only) */
161 void (*user_delete
)(void *v
, const char *user
);
163 /** @brief Called when a user is edited (admins only) */
164 void (*user_edit
)(void *v
, const char *user
, const char *property
);
166 /** @brief Called when your rights change */
167 void (*rights_changed
)(void *v
, rights_type new_rights
);
169 /** @brief Called when a track is adopted */
170 void (*adopted
)(void *v
, const char *id
, const char *who
);
171 } disorder_eclient_log_callbacks
;
175 /** @brief Play is enabled */
176 #define DISORDER_PLAYING_ENABLED 0x00000001
178 /** @brief Random play is enabled */
179 #define DISORDER_RANDOM_ENABLED 0x00000002
181 /** @brief Track is paused
183 * This is only meaningful if @ref DISORDER_PLAYING is set
185 #define DISORDER_TRACK_PAUSED 0x00000004
187 /** @brief Track is playing
189 * This can be set even if the current track is paused (in which case @ref
190 * DISORDER_TRACK_PAUSED) will also be set.
192 #define DISORDER_PLAYING 0x00000008
194 /** @brief Connected to server
196 * By connected it is meant that commands have a reasonable chance of being
197 * processed soon, not merely that a TCP connection exists - for instance if
198 * the client is still authenticating then that does not count as connected.
200 #define DISORDER_CONNECTED 0x00000010
202 char *disorder_eclient_interpret_state(unsigned long statebits
);
208 /* Completion callbacks. These provide the result of operations to the caller.
209 * Unlike in earlier releases, these are not allowed to be NULL. */
211 /** @brief Trivial completion callback
213 * @param err Error string or NULL on succes
215 typedef void disorder_eclient_no_response(void *v
,
218 /** @brief String result completion callback
220 * @param err Error string or NULL on succes
221 * @param value Result or NULL
223 * @p error will be NULL on success. In this case @p value will be the result
224 * (which might be NULL for disorder_eclient_get(),
225 * disorder_eclient_get_global() and disorder_eclient_userinfo()).
227 * @p error will be non-NULL on failure. In this case @p value is always NULL.
229 typedef void disorder_eclient_string_response(void *v
,
233 /** @brief String result completion callback
235 * @param err Error string or NULL on succes
236 * @param value Result or 0
238 * @p error will be NULL on success. In this case @p value will be the result.
240 * @p error will be non-NULL on failure. In this case @p value is always 0.
242 typedef void disorder_eclient_integer_response(void *v
,
245 /** @brief Volume completion callback
247 * @param err Error string or NULL on success
248 * @param l Left channel volume
249 * @param r Right channel volume
251 * @p error will be NULL on success. In this case @p l and @p r will be the
254 * @p error will be non-NULL on failure. In this case @p l and @p r are always
257 typedef void disorder_eclient_volume_response(void *v
,
261 /** @brief Queue request completion callback
263 * @param err Error string or NULL on success
264 * @param q Head of queue data list
266 * @p error will be NULL on success. In this case @p q will be the (head of
269 * @p error will be non-NULL on failure. In this case @p q may be NULL but
270 * MIGHT also be some subset of the queue. For consistent behavior it should
271 * be ignored in the error case.
273 typedef void disorder_eclient_queue_response(void *v
,
275 struct queue_entry
*q
);
277 /** @brief List request completion callback
279 * @param err Error string or NULL on success
280 * @param nvec Number of elements in response list
281 * @param vec Pointer to response list
283 * @p error will be NULL on success. In this case @p nvec and @p vec will give
286 * @p error will be non-NULL on failure. In this case @p nvec and @p vec will
289 typedef void disorder_eclient_list_response(void *v
,
291 int nvec
, char **vec
);
293 disorder_eclient
*disorder_eclient_new(const disorder_eclient_callbacks
*cb
,
295 /* Create a new client */
297 void disorder_eclient_close(disorder_eclient
*c
);
300 unsigned long disorder_eclient_state(const disorder_eclient
*c
);
302 void disorder_eclient_polled(disorder_eclient
*c
, unsigned mode
);
303 /* Should be called when c's FD is readable and/or writable, and in any case
304 * from time to time (so that retries work). */
306 int disorder_eclient_version(disorder_eclient
*c
,
307 disorder_eclient_string_response
*completed
,
309 /* fetch the server version */
311 int disorder_eclient_play(disorder_eclient
*c
,
313 disorder_eclient_no_response
*completed
,
315 /* add a track to the queue */
317 int disorder_eclient_pause(disorder_eclient
*c
,
318 disorder_eclient_no_response
*completed
,
320 /* add a track to the queue */
322 int disorder_eclient_resume(disorder_eclient
*c
,
323 disorder_eclient_no_response
*completed
,
325 /* add a track to the queue */
327 int disorder_eclient_scratch(disorder_eclient
*c
,
329 disorder_eclient_no_response
*completed
,
331 /* scratch a track by ID */
333 int disorder_eclient_scratch_playing(disorder_eclient
*c
,
334 disorder_eclient_no_response
*completed
,
336 /* scratch the playing track whatever it is */
338 int disorder_eclient_remove(disorder_eclient
*c
,
340 disorder_eclient_no_response
*completed
,
342 /* remove a track from the queue */
344 int disorder_eclient_moveafter(disorder_eclient
*c
,
348 disorder_eclient_no_response
*completed
,
350 /* move tracks within the queue */
352 int disorder_eclient_playing(disorder_eclient
*c
,
353 disorder_eclient_queue_response
*completed
,
355 /* find the currently playing track (0 for none) */
357 int disorder_eclient_queue(disorder_eclient
*c
,
358 disorder_eclient_queue_response
*completed
,
360 /* list recently played tracks */
362 int disorder_eclient_recent(disorder_eclient
*c
,
363 disorder_eclient_queue_response
*completed
,
365 /* list recently played tracks */
367 int disorder_eclient_files(disorder_eclient
*c
,
368 disorder_eclient_list_response
*completed
,
372 /* list files in a directory, matching RE if not a null pointer */
374 int disorder_eclient_dirs(disorder_eclient
*c
,
375 disorder_eclient_list_response
*completed
,
379 /* list directories in a directory, matching RE if not a null pointer */
381 int disorder_eclient_namepart(disorder_eclient
*c
,
382 disorder_eclient_string_response
*completed
,
387 /* look up a track name part */
389 int disorder_eclient_length(disorder_eclient
*c
,
390 disorder_eclient_integer_response
*completed
,
393 /* look up a track name length */
395 int disorder_eclient_volume(disorder_eclient
*c
,
396 disorder_eclient_volume_response
*callback
,
399 /* If L and R are both -ve gets the volume.
400 * If neither are -ve then sets the volume.
404 int disorder_eclient_enable(disorder_eclient
*c
,
405 disorder_eclient_no_response
*callback
,
407 int disorder_eclient_disable(disorder_eclient
*c
,
408 disorder_eclient_no_response
*callback
,
410 int disorder_eclient_random_enable(disorder_eclient
*c
,
411 disorder_eclient_no_response
*callback
,
413 int disorder_eclient_random_disable(disorder_eclient
*c
,
414 disorder_eclient_no_response
*callback
,
416 /* Enable/disable play/random play */
418 int disorder_eclient_resolve(disorder_eclient
*c
,
419 disorder_eclient_string_response
*completed
,
422 /* Resolve aliases */
424 int disorder_eclient_log(disorder_eclient
*c
,
425 const disorder_eclient_log_callbacks
*callbacks
,
427 /* Make this a log client (forever - it automatically becomes one again upon
430 int disorder_eclient_get(disorder_eclient
*c
,
431 disorder_eclient_string_response
*completed
,
432 const char *track
, const char *pref
,
434 int disorder_eclient_set(disorder_eclient
*c
,
435 disorder_eclient_no_response
*completed
,
436 const char *track
, const char *pref
,
439 int disorder_eclient_unset(disorder_eclient
*c
,
440 disorder_eclient_no_response
*completed
,
441 const char *track
, const char *pref
,
443 /* Get/set preference values */
445 int disorder_eclient_search(disorder_eclient
*c
,
446 disorder_eclient_list_response
*completed
,
450 int disorder_eclient_nop(disorder_eclient
*c
,
451 disorder_eclient_no_response
*completed
,
454 int disorder_eclient_new_tracks(disorder_eclient
*c
,
455 disorder_eclient_list_response
*completed
,
459 int disorder_eclient_rtp_address(disorder_eclient
*c
,
460 disorder_eclient_list_response
*completed
,
463 int disorder_eclient_users(disorder_eclient
*c
,
464 disorder_eclient_list_response
*completed
,
466 int disorder_eclient_deluser(disorder_eclient
*c
,
467 disorder_eclient_no_response
*completed
,
470 int disorder_eclient_userinfo(disorder_eclient
*c
,
471 disorder_eclient_string_response
*completed
,
473 const char *property
,
475 int disorder_eclient_edituser(disorder_eclient
*c
,
476 disorder_eclient_no_response
*completed
,
478 const char *property
,
481 int disorder_eclient_adduser(disorder_eclient
*c
,
482 disorder_eclient_no_response
*completed
,
484 const char *password
,
487 void disorder_eclient_enable_connect(disorder_eclient
*c
);
488 void disorder_eclient_disable_connect(disorder_eclient
*c
);
489 int disorder_eclient_adopt(disorder_eclient
*c
,
490 disorder_eclient_no_response
*completed
,