libmpdclient  2.17
connection.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2018 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 "protocol.h"
43 #include "error.h"
44 #include "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 
102 mpd_malloc
103 struct mpd_connection *
104 mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
105 
119 mpd_malloc
120 struct mpd_connection *
121 mpd_connection_new_async(struct mpd_async *async, const char *welcome);
122 
128 void mpd_connection_free(struct mpd_connection *connection);
129 
136 const struct mpd_settings *
137 mpd_connection_get_settings(const struct mpd_connection *connection);
138 
153 void
155  bool keepalive);
156 
169 void mpd_connection_set_timeout(struct mpd_connection *connection,
170  unsigned timeout_ms);
171 
178 mpd_pure
179 int
180 mpd_connection_get_fd(const struct mpd_connection *connection);
181 
191 mpd_pure
192 struct mpd_async *
193 mpd_connection_get_async(struct mpd_connection *connection);
194 
199 mpd_pure
200 enum mpd_error
201 mpd_connection_get_error(const struct mpd_connection *connection);
202 
213 mpd_pure
214 const char *
215 mpd_connection_get_error_message(const struct mpd_connection *connection);
216 
222 mpd_pure
223 enum mpd_server_error
224 mpd_connection_get_server_error(const struct mpd_connection *connection);
225 
234 mpd_pure
235 unsigned
237 
245 mpd_pure
246 int
247 mpd_connection_get_system_error(const struct mpd_connection *connection);
248 
257 bool
258 mpd_connection_clear_error(struct mpd_connection *connection);
259 
264 mpd_pure
265 const unsigned *
266 mpd_connection_get_server_version(const struct mpd_connection *connection);
267 
274 mpd_pure
275 int
276 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
277  unsigned major, unsigned minor,
278  unsigned patch);
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 
284 #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)