mpd/src/Idle.hxx
2013-01-16 23:23:47 +01:00

84 lines
2.0 KiB
C++

/*
* Copyright (C) 2003-2013 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_HXX
#define MPD_IDLE_HXX
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,
/** a client has subscribed or unsubscribed to/from a channel */
IDLE_SUBSCRIPTION = 0x200,
/** a message on the subscribed channel was receivedd */
IDLE_MESSAGE = 0x400,
};
/**
* 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