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 (e.g. connected refused) occurs.
46 * @param u from disorder_eclient_new()
47 * @param msg error message
49 void (*comms_error)(void *u, const char *msg);
51 /** @brief Called when a command fails (including initial authorization).
52 * @param u from disorder_eclient_new()
53 * @param v from failed command, or NULL if during setup
54 * @param msg error message
56 void (*protocol_error)(void *u, void *v, int code, const char *msg);
58 /** @brief Set poll/select flags
59 * @param u from disorder_eclient_new()
61 * @param fd file descriptor
62 * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE)
64 * Before @p fd is closed you will always get a call with @p mode = 0.
66 void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode);
68 /** @brief Report current activity
69 * @param u from disorder_eclient_new()
70 * @param msg Current activity or NULL
72 * Called with @p msg = NULL when there's nothing going on.
74 void (*report)(void *u, const char *msg);
75 } disorder_eclient_callbacks;
77 /** @brief Callbacks for log clients
79 * All of these are allowed to be a null pointers in which case you don't get
80 * told about that log event.
82 * See disorder_protocol(5) for full documentation.
84 typedef struct disorder_eclient_log_callbacks {
85 /** @brief Called on (re-)connection */
86 void (*connected)(void *v);
88 void (*completed)(void *v, const char *track);
89 void (*failed)(void *v, const char *track, const char *status);
90 void (*moved)(void *v, const char *user);
91 void (*playing)(void *v, const char *track, const char *user/*maybe 0*/);
92 void (*queue)(void *v, struct queue_entry *q);
93 void (*recent_added)(void *v, struct queue_entry *q);
94 void (*recent_removed)(void *v, const char *id);
95 void (*removed)(void *v, const char *id, const char *user/*maybe 0*/);
96 void (*scratched)(void *v, const char *track, const char *user);
97 void (*state)(void *v, unsigned long state);
98 void (*volume)(void *v, int left, int right);
99 void (*rescanned)(void *v);
100 } disorder_eclient_log_callbacks;
104 /** @brief Play is enabled */
105 #define DISORDER_PLAYING_ENABLED 0x00000001
107 /** @brief Random play is enabled */
108 #define DISORDER_RANDOM_ENABLED 0x00000002
110 /** @brief Track is paused
112 * This is only meaningful if @ref DISORDER_PLAYING is set
114 #define DISORDER_TRACK_PAUSED 0x00000004
116 /** @brief Track is playing
118 * This can be set even if the current track is paused (in which case @ref
119 * DISORDER_TRACK_PAUSED) will also be set.
121 #define DISORDER_PLAYING 0x00000008
123 /** @brief Connected to server
125 * By connected it is meant that commands have a reasonable chance of being
126 * processed soon, not merely that a TCP connection exists - for instance if
127 * the client is still authenticating then that does not count as connected.
129 #define DISORDER_CONNECTED 0x00000010
131 char *disorder_eclient_interpret_state(unsigned long statebits);
137 /* Completion callbacks. These provide the result of operations to the caller.
138 * It is always allowed for these to be null pointers if you don't care about
141 typedef void disorder_eclient_no_response(void *v);
142 /* completion callback with no data */
144 /** @brief String result completion callback
146 * @param value or NULL
148 * @p value can be NULL for disorder_eclient_get(),
149 * disorder_eclient_get_global() and disorder_eclient_userinfo().
151 typedef void disorder_eclient_string_response(void *v, const char *value);
153 typedef void disorder_eclient_integer_response(void *v, long value);
154 /* completion callback with a integer result */
156 typedef void disorder_eclient_volume_response(void *v, int l, int r);
157 /* completion callback with a pair of integer results */
159 typedef void disorder_eclient_queue_response(void *v, struct queue_entry *q);
160 /* completion callback for queue/recent listing */
162 typedef void disorder_eclient_list_response(void *v, int nvec, char **vec);
163 /* completion callback for file listing etc */
165 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
167 /* Create a new client */
169 void disorder_eclient_close(disorder_eclient *c);
172 unsigned long disorder_eclient_state(const disorder_eclient *c);
174 void disorder_eclient_polled(disorder_eclient *c, unsigned mode);
175 /* Should be called when c's FD is readable and/or writable, and in any case
176 * from time to time (so that retries work). */
178 int disorder_eclient_version(disorder_eclient *c,
179 disorder_eclient_string_response *completed,
181 /* fetch the server version */
183 int disorder_eclient_play(disorder_eclient *c,
185 disorder_eclient_no_response *completed,
187 /* add a track to the queue */
189 int disorder_eclient_pause(disorder_eclient *c,
190 disorder_eclient_no_response *completed,
192 /* add a track to the queue */
194 int disorder_eclient_resume(disorder_eclient *c,
195 disorder_eclient_no_response *completed,
197 /* add a track to the queue */
199 int disorder_eclient_scratch(disorder_eclient *c,
201 disorder_eclient_no_response *completed,
203 /* scratch a track by ID */
205 int disorder_eclient_scratch_playing(disorder_eclient *c,
206 disorder_eclient_no_response *completed,
208 /* scratch the playing track whatever it is */
210 int disorder_eclient_remove(disorder_eclient *c,
212 disorder_eclient_no_response *completed,
214 /* remove a track from the queue */
216 int disorder_eclient_moveafter(disorder_eclient *c,
220 disorder_eclient_no_response *completed,
222 /* move tracks within the queue */
224 int disorder_eclient_playing(disorder_eclient *c,
225 disorder_eclient_queue_response *completed,
227 /* find the currently playing track (0 for none) */
229 int disorder_eclient_queue(disorder_eclient *c,
230 disorder_eclient_queue_response *completed,
232 /* list recently played tracks */
234 int disorder_eclient_recent(disorder_eclient *c,
235 disorder_eclient_queue_response *completed,
237 /* list recently played tracks */
239 int disorder_eclient_files(disorder_eclient *c,
240 disorder_eclient_list_response *completed,
244 /* list files in a directory, matching RE if not a null pointer */
246 int disorder_eclient_dirs(disorder_eclient *c,
247 disorder_eclient_list_response *completed,
251 /* list directories in a directory, matching RE if not a null pointer */
253 int disorder_eclient_namepart(disorder_eclient *c,
254 disorder_eclient_string_response *completed,
259 /* look up a track name part */
261 int disorder_eclient_length(disorder_eclient *c,
262 disorder_eclient_integer_response *completed,
265 /* look up a track name length */
267 int disorder_eclient_volume(disorder_eclient *c,
268 disorder_eclient_volume_response *callback,
271 /* If L and R are both -ve gets the volume.
272 * If neither are -ve then sets the volume.
276 int disorder_eclient_enable(disorder_eclient *c,
277 disorder_eclient_no_response *callback,
279 int disorder_eclient_disable(disorder_eclient *c,
280 disorder_eclient_no_response *callback,
282 int disorder_eclient_random_enable(disorder_eclient *c,
283 disorder_eclient_no_response *callback,
285 int disorder_eclient_random_disable(disorder_eclient *c,
286 disorder_eclient_no_response *callback,
288 /* Enable/disable play/random play */
290 int disorder_eclient_resolve(disorder_eclient *c,
291 disorder_eclient_string_response *completed,
294 /* Resolve aliases */
296 int disorder_eclient_log(disorder_eclient *c,
297 const disorder_eclient_log_callbacks *callbacks,
299 /* Make this a log client (forever - it automatically becomes one again upon
302 int disorder_eclient_get(disorder_eclient *c,
303 disorder_eclient_string_response *completed,
304 const char *track, const char *pref,
306 int disorder_eclient_set(disorder_eclient *c,
307 disorder_eclient_no_response *completed,
308 const char *track, const char *pref,
311 int disorder_eclient_unset(disorder_eclient *c,
312 disorder_eclient_no_response *completed,
313 const char *track, const char *pref,
315 /* Get/set preference values */
317 int disorder_eclient_search(disorder_eclient *c,
318 disorder_eclient_list_response *completed,
322 int disorder_eclient_nop(disorder_eclient *c,
323 disorder_eclient_no_response *completed,
326 int disorder_eclient_new_tracks(disorder_eclient *c,
327 disorder_eclient_list_response *completed,
331 int disorder_eclient_rtp_address(disorder_eclient *c,
332 disorder_eclient_list_response *completed,
335 int disorder_eclient_users(disorder_eclient *c,
336 disorder_eclient_list_response *completed,
338 int disorder_eclient_deluser(disorder_eclient *c,
339 disorder_eclient_no_response *completed,
342 int disorder_eclient_userinfo(disorder_eclient *c,
343 disorder_eclient_string_response *completed,
345 const char *property,
347 int disorder_eclient_edituser(disorder_eclient *c,
348 disorder_eclient_no_response *completed,
350 const char *property,
353 int disorder_eclient_adduser(disorder_eclient *c,
354 disorder_eclient_no_response *completed,
356 const char *password,