mpd/src/idle.h
Max Kellermann d4914fc9ef idle: added "update" event
Some clients have visual feedback for "database update is running".
Using the "database" idle event is unreliable, because it is only
emitted when the database was actually modified.  This patch adds the
"update" event, which is emitted when the update is started, and again
when the update is finished, disregarding whether it has been
modified.
2009-07-05 08:46:53 +02:00

90 lines
2.0 KiB
C

/*
* Copyright (C) 2003-2009 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
/*
* Support library for the "idle" command.
*
*/
#ifndef MPD_IDLE_H
#define MPD_IDLE_H
enum {
/** song database has been updated*/
IDLE_DATABASE = 0x1,
/** a stored playlist has been modified, created, deleted or
renamed */
IDLE_STORED_PLAYLIST = 0x2,
/** the current playlist has been modified */
IDLE_PLAYLIST = 0x4,
/** the player state has changed: play, stop, pause, seek, ... */
IDLE_PLAYER = 0x8,
/** the volume has been modified */
IDLE_MIXER = 0x10,
/** an audio output device has been enabled or disabled */
IDLE_OUTPUT = 0x20,
/** options have changed: crossfade, random, repeat, ... */
IDLE_OPTIONS = 0x40,
/** a sticker has been modified. */
IDLE_STICKER = 0x80,
/** a database update has started or finished. */
IDLE_UPDATE = 0x100,
};
/**
* Initialize the mutex
*/
void
idle_init(void);
/**
* Destroy the mutex
*/
void
idle_deinit(void);
/**
* Adds idle flag (with bitwise "or") and queues notifications to all
* clients.
*/
void
idle_add(unsigned flags);
/**
* Atomically reads and resets the global idle flags value.
*/
unsigned
idle_get(void);
/**
* Get idle names
*/
const char*const*
idle_get_names(void);
#endif