src/gidle.h

   1 /* ncmpc (Ncurses MPD Client)
   2    (c) 2004-2017 The Music Player Daemon Project
   3    Project homepage: http://musicpd.org
   4
   5    Redistribution and use in source and binary forms, with or without
   6    modification, are permitted provided that the following conditions
   7    are met:
   8
   9    - Redistributions of source code must retain the above copyright
  10    notice, this list of conditions and the following disclaimer.
  11
  12    - Redistributions in binary form must reproduce the above copyright
  13    notice, this list of conditions and the following disclaimer in the
  14    documentation and/or other materials provided with the distribution.
  15
  16    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  20    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  21    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  22    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  23    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  24    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  25    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  26    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 */
  28
  29 #ifndef MPD_GLIB_SOURCE_H
  30 #define MPD_GLIB_SOURCE_H
  31
  32 #include <mpd/client.h>
  33
  34 typedef void (*mpd_glib_callback_t)(enum mpd_error error,
  35                                     enum mpd_server_error server_error,
  36                                     const char *message,
  37                                     enum mpd_idle events, void *ctx);
  38
  39 struct mpd_glib_source;
  40
  41 struct mpd_glib_source *
  42 mpd_glib_new(struct mpd_connection *connection,
  43              mpd_glib_callback_t callback, void *callback_ctx);
  44
  45 void
  46 mpd_glib_free(struct mpd_glib_source *source);
  47
  48 /**
  49  * Enters idle mode.
  50  *
  51  * @return true if idle mode has been entered, false if not
  52  * (e.g. blocked during the callback, or I/O error)
  53  */
  54 bool
  55 mpd_glib_enter(struct mpd_glib_source *source);
  56
  57 /**
  58  * Leaves idle mode and invokes the callback if there were events.
  59  *
  60  * @return true on success, false if this object was deleted by the
  61  * callback
  62  */
  63 bool
  64 mpd_glib_leave(struct mpd_glib_source *source);
  65
  66 #endif