chiark - git - mdw - disorder/blob - lib/eclient.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006, 2007 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20 /** @file lib/eclient.h
  21  * @brief Client code for event-driven programs
  22  */
  23
  24 #ifndef ECLIENT_H
  25 #define ECLIENT_H
  26
  27 /* Asynchronous client interface */
  28
  29 /** @brief Handle type */
  30 typedef struct disorder_eclient disorder_eclient;
  31
  32 struct queue_entry;
  33
  34 /** @brief Set to read from the FD */
  35 #define DISORDER_POLL_READ 1u
  36
  37 /** @brief Set to write to the FD */
  38 #define DISORDER_POLL_WRITE 2u
  39
  40 /** @brief Callbacks for all clients
  41  *
  42  * These must all be valid.
  43  */
  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
  48    *
  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.
  52    */
  53   void (*comms_error)(void *u, const char *msg);
  54
  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
  59    *
  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
  63    * generic callback.
  64    */
  65   void (*protocol_error)(void *u, void *v, int code, const char *msg);
  66
  67   /** @brief Set poll/select flags
  68    * @param u from disorder_eclient_new()
  69    * @param c handle
  70    * @param fd file descriptor
  71    * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE)
  72    *
  73    * Before @p fd is closed you will always get a call with @p mode = 0.
  74    */
  75   void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode);
  76
  77   /** @brief Report current activity
  78    * @param u from disorder_eclient_new()
  79    * @param msg Current activity or NULL
  80    *
  81    * Called with @p msg = NULL when there's nothing going on.
  82    */
  83   void (*report)(void *u, const char *msg);
  84 } disorder_eclient_callbacks;
  85
  86 /** @brief Callbacks for log clients
  87  *
  88  * All of these are allowed to be a null pointers in which case you don't get
  89  * told about that log event.
  90  *
  91  * See disorder_protocol(5) for full documentation.
  92  */
  93 typedef struct disorder_eclient_log_callbacks {
  94   /** @brief Called on (re-)connection */
  95   void (*connected)(void *v);
  96
  97   /** @brief Called when @p track finished playing successfully */
  98   void (*completed)(void *v, const char *track);
  99
 100   /** @brief Called when @p track fails for some reason */
 101   void (*failed)(void *v, const char *track, const char *status);
 102
 103   /** @brief Called when @p user moves some track or tracks in the queue
 104    *
 105    * Fetch the queue again to find out what the new order is - the
 106    * rearrangement could in principle be arbitrarily complicated.
 107    */
 108   void (*moved)(void *v, const char *user);
 109
 110   /** @brief Called when @p track starts playing
 111    *
 112    * @p user might be 0.
 113    */
 114   void (*playing)(void *v, const char *track, const char *user/*maybe 0*/);
 115
 116   /** @brief Called when @p q is added to the queue
 117    *
 118    * Fetch the queue again to find out where the in the queue it was added.
 119    */
 120   void (*queue)(void *v, struct queue_entry *q);
 121
 122   /** @brief Called when @p q is added to the recent list */
 123   void (*recent_added)(void *v, struct queue_entry *q);
 124
 125   /** @brief Called when @p id is removed from the recent list */
 126   void (*recent_removed)(void *v, const char *id);
 127
 128   /** @brief Called when @id is removed from the queue
 129    *
 130    * @p user might be 0.
 131    */
 132   void (*removed)(void *v, const char *id, const char *user/*maybe 0*/);
 133
 134   /** @brief Called when @p track is scratched */
 135   void (*scratched)(void *v, const char *track, const char *user);
 136
 137   /** @brief Called with the current state whenever it changes
 138    *
 139    * State bits are:
 140    * - @ref DISORDER_PLAYING_ENABLED
 141    * - @ref DISORDER_RANDOM_ENABLED
 142    * - @ref DISORDER_TRACK_PAUSED
 143    * - @ref DISORDER_PLAYING
 144    * - @ref DISORDER_CONNECTED
 145    */
 146   void (*state)(void *v, unsigned long state);
 147
 148   /** @brief Called when the volume changes */
 149   void (*volume)(void *v, int left, int right);
 150
 151   /** @brief Called when a rescan completes */
 152   void (*rescanned)(void *v);
 153
 154   /** @brief Called when a user is created (admins only) */
 155   void (*user_add)(void *v, const char *user);
 156
 157   /** @brief Called when a user is confirmed (admins only) */
 158   void (*user_confirm)(void *v, const char *user);
 159
 160   /** @brief Called when a user is deleted (admins only) */
 161   void (*user_delete)(void *v, const char *user);
 162
 163   /** @brief Called when a user is edited (admins only) */
 164   void (*user_edit)(void *v, const char *user, const char *property);
 165 } disorder_eclient_log_callbacks;
 166
 167 /* State bits */
 168
 169 /** @brief Play is enabled */
 170 #define DISORDER_PLAYING_ENABLED  0x00000001
 171
 172 /** @brief Random play is enabled */
 173 #define DISORDER_RANDOM_ENABLED   0x00000002
 174
 175 /** @brief Track is paused
 176  *
 177  * This is only meaningful if @ref DISORDER_PLAYING is set
 178  */
 179 #define DISORDER_TRACK_PAUSED     0x00000004
 180
 181 /** @brief Track is playing
 182  *
 183  * This can be set even if the current track is paused (in which case @ref
 184  * DISORDER_TRACK_PAUSED) will also be set.
 185  */
 186 #define DISORDER_PLAYING    0x00000008
 187
 188 /** @brief Connected to server
 189  *
 190  * By connected it is meant that commands have a reasonable chance of being
 191  * processed soon, not merely that a TCP connection exists - for instance if
 192  * the client is still authenticating then that does not count as connected.
 193  */
 194 #define DISORDER_CONNECTED        0x00000010
 195
 196 char *disorder_eclient_interpret_state(unsigned long statebits);
 197
 198 struct queue_entry;
 199 struct kvp;
 200 struct sink;
 201
 202 /* Completion callbacks.  These provide the result of operations to the caller.
 203  * Unlike in earlier releases, these are not allowed to be NULL. */
 204
 205 /** @brief Trivial completion callback
 206  * @param v User data
 207  * @param error Error string or NULL on succes
 208  */
 209 typedef void disorder_eclient_no_response(void *v,
 210                                           const char *error);
 211
 212 /** @brief String result completion callback
 213  * @param v User data
 214  * @param error Error string or NULL on succes
 215  * @param value Result or NULL
 216  *
 217  * @p error will be NULL on success.  In this case @p value will be the result
 218  * (which might be NULL for disorder_eclient_get(),
 219  * disorder_eclient_get_global() and disorder_eclient_userinfo()).
 220  *
 221  * @p error will be non-NULL on failure.  In this case @p value is always NULL.
 222  */
 223 typedef void disorder_eclient_string_response(void *v,
 224                                               const char *error,
 225                                               const char *value);
 226
 227 /** @brief String result completion callback
 228  * @param v User data
 229  * @param error Error string or NULL on succes
 230  * @param value Result or 0
 231  *
 232  * @p error will be NULL on success.  In this case @p value will be the result.
 233  *
 234  * @p error will be non-NULL on failure.  In this case @p value is always 0.
 235  */
 236 typedef void disorder_eclient_integer_response(void *v,
 237                                                const char *error,
 238                                                long value);
 239 /** @brief Volume completion callback
 240  * @param v User data
 241  * @param error Error string or NULL on success
 242  * @param l Left channel volume
 243  * @param r Right channel volume
 244  *
 245  * @p error will be NULL on success.  In this case @p l and @p r will be the
 246  * result.
 247  *
 248  * @p error will be non-NULL on failure.  In this case @p l and @p r are always
 249  * 0.
 250  */
 251 typedef void disorder_eclient_volume_response(void *v,
 252                                               const char *error,
 253                                               int l, int r);
 254
 255 /** @brief Queue request completion callback
 256  * @param v User data
 257  * @param error Error string or NULL on success
 258  * @param q Head of queue data list
 259  *
 260  * @p error will be NULL on success.  In this case @p q will be the (head of
 261  * the) result.
 262  *
 263  * @p error will be non-NULL on failure.  In this case @p q may be NULL but
 264  * MIGHT also be some subset of the queue.  For consistent behavior it should
 265  * be ignored in the error case.
 266  */
 267 typedef void disorder_eclient_queue_response(void *v,
 268                                              const char *error,
 269                                              struct queue_entry *q);
 270
 271 /** @brief List request completion callback
 272  * @param v User data
 273  * @param error Error string or NULL on success
 274  * @param nvec Number of elements in response list
 275  * @param vec Pointer to response list
 276  *
 277  * @p error will be NULL on success.  In this case @p nvec and @p vec will give
 278  * the result.
 279  *
 280  * @p error will be non-NULL on failure.  In this case @p nvec and @p vec will
 281  * be 0 and NULL.
 282  */
 283 typedef void disorder_eclient_list_response(void *v,
 284                                             const char *error,
 285                                             int nvec, char **vec);
 286
 287 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
 288                                        void *u);
 289 /* Create a new client */
 290
 291 void disorder_eclient_close(disorder_eclient *c);
 292 /* Close C */
 293
 294 unsigned long disorder_eclient_state(const disorder_eclient *c);
 295
 296 void disorder_eclient_polled(disorder_eclient *c, unsigned mode);
 297 /* Should be called when c's FD is readable and/or writable, and in any case
 298  * from time to time (so that retries work). */
 299
 300 int disorder_eclient_version(disorder_eclient *c,
 301                              disorder_eclient_string_response *completed,
 302                              void *v);
 303 /* fetch the server version */
 304
 305 int disorder_eclient_play(disorder_eclient *c,
 306                           const char *track,
 307                           disorder_eclient_no_response *completed,
 308                           void *v);
 309 /* add a track to the queue */
 310
 311 int disorder_eclient_pause(disorder_eclient *c,
 312                            disorder_eclient_no_response *completed,
 313                            void *v);
 314 /* add a track to the queue */
 315
 316 int disorder_eclient_resume(disorder_eclient *c,
 317                             disorder_eclient_no_response *completed,
 318                             void *v);
 319 /* add a track to the queue */
 320
 321 int disorder_eclient_scratch(disorder_eclient *c,
 322                              const char *id,
 323                              disorder_eclient_no_response *completed,
 324                              void *v);
 325 /* scratch a track by ID */
 326
 327 int disorder_eclient_scratch_playing(disorder_eclient *c,
 328                                      disorder_eclient_no_response *completed,
 329                                      void *v);
 330 /* scratch the playing track whatever it is */
 331
 332 int disorder_eclient_remove(disorder_eclient *c,
 333                             const char *id,
 334                             disorder_eclient_no_response *completed,
 335                             void *v);
 336 /* remove a track from the queue */
 337
 338 int disorder_eclient_moveafter(disorder_eclient *c,
 339                                const char *target,
 340                                int nids,
 341                                const char **ids,
 342                                disorder_eclient_no_response *completed,
 343                                void *v);
 344 /* move tracks within the queue */
 345
 346 int disorder_eclient_playing(disorder_eclient *c,
 347                              disorder_eclient_queue_response *completed,
 348                              void *v);
 349 /* find the currently playing track (0 for none) */
 350
 351 int disorder_eclient_queue(disorder_eclient *c,
 352                            disorder_eclient_queue_response *completed,
 353                            void *v);
 354 /* list recently played tracks */
 355
 356 int disorder_eclient_recent(disorder_eclient *c,
 357                             disorder_eclient_queue_response *completed,
 358                             void *v);
 359 /* list recently played tracks */
 360
 361 int disorder_eclient_files(disorder_eclient *c,
 362                            disorder_eclient_list_response *completed,
 363                            const char *dir,
 364                            const char *re,
 365                            void *v);
 366 /* list files in a directory, matching RE if not a null pointer */
 367
 368 int disorder_eclient_dirs(disorder_eclient *c,
 369                           disorder_eclient_list_response *completed,
 370                           const char *dir,
 371                           const char *re,
 372                           void *v);
 373 /* list directories in a directory, matching RE if not a null pointer */
 374
 375 int disorder_eclient_namepart(disorder_eclient *c,
 376                               disorder_eclient_string_response *completed,
 377                               const char *track,
 378                               const char *context,
 379                               const char *part,
 380                               void *v);
 381 /* look up a track name part */
 382
 383 int disorder_eclient_length(disorder_eclient *c,
 384                             disorder_eclient_integer_response *completed,
 385                             const char *track,
 386                             void *v);
 387 /* look up a track name length */
 388
 389 int disorder_eclient_volume(disorder_eclient *c,
 390                             disorder_eclient_volume_response *callback,
 391                             int l, int r,
 392                             void *v);
 393 /* If L and R are both -ve gets the volume.
 394  * If neither are -ve then sets the volume.
 395  * Otherwise asserts!
 396  */
 397
 398 int disorder_eclient_enable(disorder_eclient *c,
 399                             disorder_eclient_no_response *callback,
 400                             void *v);
 401 int disorder_eclient_disable(disorder_eclient *c,
 402                              disorder_eclient_no_response *callback,
 403                              void *v);
 404 int disorder_eclient_random_enable(disorder_eclient *c,
 405                                    disorder_eclient_no_response *callback,
 406                                    void *v);
 407 int disorder_eclient_random_disable(disorder_eclient *c,
 408                                     disorder_eclient_no_response *callback,
 409                                     void *v);
 410 /* Enable/disable play/random play */
 411
 412 int disorder_eclient_resolve(disorder_eclient *c,
 413                              disorder_eclient_string_response *completed,
 414                              const char *track,
 415                              void *v);
 416 /* Resolve aliases */
 417
 418 int disorder_eclient_log(disorder_eclient *c,
 419                          const disorder_eclient_log_callbacks *callbacks,
 420                          void *v);
 421 /* Make this a log client (forever - it automatically becomes one again upon
 422  * reconnection) */
 423
 424 int disorder_eclient_get(disorder_eclient *c,
 425                          disorder_eclient_string_response *completed,
 426                          const char *track, const char *pref,
 427                          void *v);
 428 int disorder_eclient_set(disorder_eclient *c,
 429                          disorder_eclient_no_response *completed,
 430                          const char *track, const char *pref,
 431                          const char *value,
 432                          void *v);
 433 int disorder_eclient_unset(disorder_eclient *c,
 434                            disorder_eclient_no_response *completed,
 435                            const char *track, const char *pref,
 436                            void *v);
 437 /* Get/set preference values */
 438
 439 int disorder_eclient_search(disorder_eclient *c,
 440                             disorder_eclient_list_response *completed,
 441                             const char *terms,
 442                             void *v);
 443
 444 int disorder_eclient_nop(disorder_eclient *c,
 445                          disorder_eclient_no_response *completed,
 446                          void *v);
 447
 448 int disorder_eclient_new_tracks(disorder_eclient *c,
 449                                 disorder_eclient_list_response *completed,
 450                                 int max,
 451                                 void *v);
 452
 453 int disorder_eclient_rtp_address(disorder_eclient *c,
 454                                  disorder_eclient_list_response *completed,
 455                                  void *v);
 456
 457 int disorder_eclient_users(disorder_eclient *c,
 458                            disorder_eclient_list_response *completed,
 459                            void *v);
 460 int disorder_eclient_deluser(disorder_eclient *c,
 461                              disorder_eclient_no_response *completed,
 462                              const char *user,
 463                              void *v);
 464 int disorder_eclient_userinfo(disorder_eclient *c,
 465                               disorder_eclient_string_response *completed,
 466                               const char *user,
 467                               const char *property,
 468                               void *v);
 469 int disorder_eclient_edituser(disorder_eclient *c,
 470                               disorder_eclient_no_response *completed,
 471                               const char *user,
 472                               const char *property,
 473                               const char *value,
 474                               void *v);
 475 int disorder_eclient_adduser(disorder_eclient *c,
 476                              disorder_eclient_no_response *completed,
 477                              const char *user,
 478                              const char *password,
 479                              const char *rights,
 480                              void *v);
 481
 482 #endif
 483
 484 /*
 485 Local Variables:
 486 c-basic-offset:2
 487 comment-column:40
 488 fill-column:79
 489 indent-tabs-mode:nil
 490 End:
 491 */