libmpdclient 2.14

idle.h
Go to the documentation of this file.
1 /* libmpdclient
2 (c) 2003-2017 The Music Player Daemon Project
3 This project's homepage is: http://www.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 - Neither the name of the Music Player Daemon nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
39 #ifndef MPD_IDLE_H
40 #define MPD_IDLE_H
41
42 #include "compiler.h"
43
44 #include <stdbool.h>
45
46 struct mpd_pair;
47 struct mpd_connection;
48
55 enum mpd_idle {
57 MPD_IDLE_DATABASE = 0x1,
58
61 MPD_IDLE_STORED_PLAYLIST = 0x2,
62
64 MPD_IDLE_QUEUE = 0x4,
65
67 MPD_IDLE_PLAYLIST = MPD_IDLE_QUEUE,
68
70 MPD_IDLE_PLAYER = 0x8,
71
73 MPD_IDLE_MIXER = 0x10,
74
76 MPD_IDLE_OUTPUT = 0x20,
77
79 MPD_IDLE_OPTIONS = 0x40,
80
82 MPD_IDLE_UPDATE = 0x80,
83
85 MPD_IDLE_STICKER = 0x100,
86
88 MPD_IDLE_SUBSCRIPTION = 0x200,
89
91 MPD_IDLE_MESSAGE = 0x400,
92 };
93
94 #ifdef __cplusplus
95 extern "C" {
96 #endif
97
104 mpd_const
105 const char *
106 mpd_idle_name(enum mpd_idle idle);
107
114 mpd_pure
115 enum mpd_idle
116 mpd_idle_name_parse(const char *name);
117
124 bool
125 mpd_send_idle(struct mpd_connection *connection);
126
134 bool
135 mpd_send_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
136
142 bool
143 mpd_send_noidle(struct mpd_connection *connection);
144
151 mpd_pure
152 enum mpd_idle
153 mpd_idle_parse_pair(const struct mpd_pair *pair);
154
167 enum mpd_idle
168 mpd_recv_idle(struct mpd_connection *connection, bool disable_timeout);
169
177 enum mpd_idle
178 mpd_run_idle(struct mpd_connection *connection);
179
188 enum mpd_idle
189 mpd_run_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
190
199 enum mpd_idle
200 mpd_run_noidle(struct mpd_connection *connection);
201
202 #ifdef __cplusplus
203 }
204 #endif
205
206 #endif
MPD_IDLE_MESSAGE
Definition: idle.h:91
mpd_send_noidle
bool mpd_send_noidle(struct mpd_connection *connection)
MPD_IDLE_UPDATE
Definition: idle.h:82
MPD_IDLE_MIXER
Definition: idle.h:73
mpd_run_idle
enum mpd_idle mpd_run_idle(struct mpd_connection *connection)
MPD_IDLE_PLAYER
Definition: idle.h:70
MPD_IDLE_STICKER
Definition: idle.h:85
mpd_idle_name
mpd_const const char * mpd_idle_name(enum mpd_idle idle)
compiler.h
Compiler specific definitions.
MPD_IDLE_OPTIONS
Definition: idle.h:79
mpd_run_idle_mask
enum mpd_idle mpd_run_idle_mask(struct mpd_connection *connection, enum mpd_idle mask)
mpd_send_idle_mask
bool mpd_send_idle_mask(struct mpd_connection *connection, enum mpd_idle mask)
mpd_recv_idle
enum mpd_idle mpd_recv_idle(struct mpd_connection *connection, bool disable_timeout)
mpd_idle
mpd_idle
Definition: idle.h:55
MPD_IDLE_DATABASE
Definition: idle.h:57
MPD_IDLE_PLAYLIST
Definition: idle.h:67
mpd_run_noidle
enum mpd_idle mpd_run_noidle(struct mpd_connection *connection)
MPD_IDLE_STORED_PLAYLIST
Definition: idle.h:61
mpd_connection
Definition: connection.h:48
MPD_IDLE_QUEUE
Definition: idle.h:64
mpd_pair
Definition: pair.h:41
MPD_IDLE_OUTPUT
Definition: idle.h:76
mpd_idle_name_parse
mpd_pure enum mpd_idle mpd_idle_name_parse(const char *name)
MPD_IDLE_SUBSCRIPTION
Definition: idle.h:88
mpd_idle_parse_pair
mpd_pure enum mpd_idle mpd_idle_parse_pair(const struct mpd_pair *pair)
mpd_send_idle
bool mpd_send_idle(struct mpd_connection *connection)