libmpdclient  2.10
connection.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2015 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_CONNECTION_H
40 #define MPD_CONNECTION_H
41 
42 #include <mpd/protocol.h>
43 #include <mpd/error.h>
44 #include <mpd/compiler.h>
45 
46 #include <stdbool.h>
47 
48 struct mpd_async;
49 
72 struct mpd_connection;
73 
74 #ifdef __cplusplus
75 extern "C" {
76 #endif
77 
99 mpd_malloc
100 struct mpd_connection *
101 mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
102 
116 mpd_malloc
117 struct mpd_connection *
118 mpd_connection_new_async(struct mpd_async *async, const char *welcome);
119 
125 void mpd_connection_free(struct mpd_connection *connection);
126 
131 const struct mpd_settings *
132 mpd_connection_get_settings(const struct mpd_connection *connection);
133 
146 void mpd_connection_set_keepalive(struct mpd_connection *connection,
147  bool keepalive);
148 
161 void mpd_connection_set_timeout(struct mpd_connection *connection,
162  unsigned timeout_ms);
163 
170 mpd_pure
171 int
172 mpd_connection_get_fd(const struct mpd_connection *connection);
173 
183 mpd_pure
184 struct mpd_async *
185 mpd_connection_get_async(struct mpd_connection *connection);
186 
191 mpd_pure
192 enum mpd_error
193 mpd_connection_get_error(const struct mpd_connection *connection);
194 
205 mpd_pure
206 const char *
207 mpd_connection_get_error_message(const struct mpd_connection *connection);
208 
214 mpd_pure
215 enum mpd_server_error
216 mpd_connection_get_server_error(const struct mpd_connection *connection);
217 
224 mpd_pure
225 unsigned
227 
235 mpd_pure
236 int
237 mpd_connection_get_system_error(const struct mpd_connection *connection);
238 
247 bool
248 mpd_connection_clear_error(struct mpd_connection *connection);
249 
254 mpd_pure
255 const unsigned *
256 mpd_connection_get_server_version(const struct mpd_connection *connection);
257 
264 mpd_pure
265 int
266 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
267  unsigned major, unsigned minor,
268  unsigned patch);
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 
274 #endif
mpd_pure unsigned mpd_connection_get_server_error_location(const struct mpd_connection *connection)
mpd_pure const unsigned * mpd_connection_get_server_version(const struct mpd_connection *connection)
mpd_pure int mpd_connection_get_system_error(const struct mpd_connection *connection)
mpd_pure enum mpd_server_error mpd_connection_get_server_error(const struct mpd_connection *connection)
mpd_malloc struct mpd_connection * mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms)
mpd_server_error
Definition: protocol.h:39
void mpd_connection_set_timeout(struct mpd_connection *connection, unsigned timeout_ms)
mpd_error
Definition: error.h:39
MPD client library.
MPD client library.
mpd_pure int mpd_connection_cmp_server_version(const struct mpd_connection *connection, unsigned major, unsigned minor, unsigned patch)
const struct mpd_settings * mpd_connection_get_settings(const struct mpd_connection *connection)
Compiler specific definitions.
bool mpd_connection_clear_error(struct mpd_connection *connection)
mpd_pure enum mpd_error mpd_connection_get_error(const struct mpd_connection *connection)
mpd_malloc struct mpd_connection * mpd_connection_new_async(struct mpd_async *async, const char *welcome)
void mpd_connection_free(struct mpd_connection *connection)
mpd_pure struct mpd_async * mpd_connection_get_async(struct mpd_connection *connection)
mpd_pure const char * mpd_connection_get_error_message(const struct mpd_connection *connection)
void mpd_connection_set_keepalive(struct mpd_connection *connection, bool keepalive)
mpd_pure int mpd_connection_get_fd(const struct mpd_connection *connection)