src/idle.h

   1 /*
   2  * Copyright (C) 2003-2009 The Music Player Daemon Project
   3  * http://www.musicpd.org
   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,
  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.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 /*
  21  * Support library for the "idle" command.
  22  *
  23  */
  24
  25 #ifndef MPD_IDLE_H
  26 #define MPD_IDLE_H
  27
  28 enum {
  29         /** song database has been updated*/
  30         IDLE_DATABASE = 0x1,
  31
  32         /** a stored playlist has been modified, created, deleted or
  33             renamed */
  34         IDLE_STORED_PLAYLIST = 0x2,
  35
  36         /** the current playlist has been modified */
  37         IDLE_PLAYLIST = 0x4,
  38
  39         /** the player state has changed: play, stop, pause, seek, ... */
  40         IDLE_PLAYER = 0x8,
  41
  42         /** the volume has been modified */
  43         IDLE_MIXER = 0x10,
  44
  45         /** an audio output device has been enabled or disabled */
  46         IDLE_OUTPUT = 0x20,
  47
  48         /** options have changed: crossfade, random, repeat, ... */
  49         IDLE_OPTIONS = 0x40,
  50
  51         /** a sticker has been modified. */
  52         IDLE_STICKER = 0x80,
  53
  54         /** a database update has started or finished. */
  55         IDLE_UPDATE = 0x100,
  56 };
  57
  58 /**
  59  * Initialize the mutex
  60  */
  61 void
  62 idle_init(void);
  63
  64 /**
  65  * Destroy the mutex
  66  */
  67 void
  68 idle_deinit(void);
  69
  70 /**
  71  * Adds idle flag (with bitwise "or") and queues notifications to all
  72  * clients.
  73  */
  74 void
  75 idle_add(unsigned flags);
  76
  77 /**
  78  * Atomically reads and resets the global idle flags value.
  79  */
  80 unsigned
  81 idle_get(void);
  82
  83 /**
  84  * Get idle names
  85  */
  86 const char*const*
  87 idle_get_names(void);
  88
  89 #endif