idle.h

Go to the documentation of this file.

/* libmpdclient
   (c) 2003-2019 The Music Player Daemon Project
   This project's homepage is: http://www.musicpd.org
 
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
 
   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 
   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
   - Neither the name of the Music Player Daemon nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef MPD_IDLE_H
#define MPD_IDLE_H
 
#include "compiler.h"
 
#include <stdbool.h>
 
struct mpd_pair;
struct mpd_connection;
 
enum mpd_idle {
    MPD_IDLE_DATABASE = 0x1,
 
    MPD_IDLE_STORED_PLAYLIST = 0x2,
 
    MPD_IDLE_QUEUE = 0x4,
 
    MPD_IDLE_PLAYLIST = MPD_IDLE_QUEUE,
 
    MPD_IDLE_PLAYER = 0x8,
 
    MPD_IDLE_MIXER = 0x10,
 
    MPD_IDLE_OUTPUT = 0x20,
 
    MPD_IDLE_OPTIONS = 0x40,
 
    MPD_IDLE_UPDATE = 0x80,
 
    MPD_IDLE_STICKER = 0x100,
 
    MPD_IDLE_SUBSCRIPTION = 0x200,
 
    MPD_IDLE_MESSAGE = 0x400,
 
    MPD_IDLE_PARTITION = 0x800,
 
    MPD_IDLE_NEIGHBOR = 0x1000,
 
    MPD_IDLE_MOUNT = 0x2000,
};
 
#ifdef __cplusplus
extern "C" {
#endif
 
mpd_const
const char *
mpd_idle_name(enum mpd_idle idle);
 
mpd_pure
enum mpd_idle
mpd_idle_name_parse(const char *name);
 
bool
mpd_send_idle(struct mpd_connection *connection);
 
bool
mpd_send_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
 
bool
mpd_send_noidle(struct mpd_connection *connection);
 
mpd_pure
enum mpd_idle
mpd_idle_parse_pair(const struct mpd_pair *pair);
 
enum mpd_idle
mpd_recv_idle(struct mpd_connection *connection, bool disable_timeout);
 
enum mpd_idle
mpd_run_idle(struct mpd_connection *connection);
 
enum mpd_idle
mpd_run_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
 
enum mpd_idle
mpd_run_noidle(struct mpd_connection *connection);
 
#ifdef __cplusplus
}
#endif
 
#endif