libmpdclient  2.9
idle.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2010 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 <mpd/compiler.h>
43 
44 #include <stdbool.h>
45 
46 struct mpd_pair;
47 struct mpd_connection;
48 
52 enum mpd_idle {
55 
59 
62 
65 
68 
71 
74 
77 
80 
83 
86 
89 };
90 
91 #ifdef __cplusplus
92 extern "C" {
93 #endif
94 
101 mpd_const
102 const char *
103 mpd_idle_name(enum mpd_idle idle);
104 
111 mpd_pure
112 enum mpd_idle
113 mpd_idle_name_parse(const char *name);
114 
121 bool
122 mpd_send_idle(struct mpd_connection *connection);
123 
131 bool
132 mpd_send_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
133 
139 bool
140 mpd_send_noidle(struct mpd_connection *connection);
141 
148 mpd_pure
149 enum mpd_idle
150 mpd_idle_parse_pair(const struct mpd_pair *pair);
151 
164 enum mpd_idle
165 mpd_recv_idle(struct mpd_connection *connection, bool disable_timeout);
166 
174 enum mpd_idle
175 mpd_run_idle(struct mpd_connection *connection);
176 
185 enum mpd_idle
186 mpd_run_idle_mask(struct mpd_connection *connection, enum mpd_idle mask);
187 
196 enum mpd_idle
197 mpd_run_noidle(struct mpd_connection *connection);
198 
199 #ifdef __cplusplus
200 }
201 #endif
202 
203 #endif