libmpdclient  2.19
connection.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2019 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 
94 struct mpd_connection;
95 
96 #ifdef __cplusplus
97 extern "C" {
98 #endif
99 
124 mpd_malloc
125 struct mpd_connection *
126 mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
127 
141 mpd_malloc
142 struct mpd_connection *
143 mpd_connection_new_async(struct mpd_async *async, const char *welcome);
144 
150 void mpd_connection_free(struct mpd_connection *connection);
151 
158 const struct mpd_settings *
159 mpd_connection_get_settings(const struct mpd_connection *connection);
160 
176 bool
178  bool keepalive);
179 
192 void mpd_connection_set_timeout(struct mpd_connection *connection,
193  unsigned timeout_ms);
194 
217 mpd_pure
218 int
219 mpd_connection_get_fd(const struct mpd_connection *connection);
220 
230 mpd_pure
231 struct mpd_async *
232 mpd_connection_get_async(struct mpd_connection *connection);
233 
238 mpd_pure
239 enum mpd_error
240 mpd_connection_get_error(const struct mpd_connection *connection);
241 
252 mpd_pure
253 const char *
254 mpd_connection_get_error_message(const struct mpd_connection *connection);
255 
261 mpd_pure
262 enum mpd_server_error
263 mpd_connection_get_server_error(const struct mpd_connection *connection);
264 
273 mpd_pure
274 unsigned
276 
284 mpd_pure
285 int
286 mpd_connection_get_system_error(const struct mpd_connection *connection);
287 
296 bool
297 mpd_connection_clear_error(struct mpd_connection *connection);
298 
303 mpd_pure
304 const unsigned *
305 mpd_connection_get_server_version(const struct mpd_connection *connection);
306 
313 mpd_pure
314 int
315 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
316  unsigned major, unsigned minor,
317  unsigned patch);
318 
319 #ifdef __cplusplus
320 }
321 #endif
322 
323 #endif
struct mpd_connection * mpd_connection_new_async(struct mpd_async *async, const char *welcome)
enum mpd_server_error mpd_connection_get_server_error(const struct mpd_connection *connection)
int mpd_connection_get_system_error(const struct mpd_connection *connection)
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
bool mpd_connection_set_keepalive(struct mpd_connection *connection, bool keepalive)
MPD client library.
MPD client library.
const struct mpd_settings * mpd_connection_get_settings(const struct mpd_connection *connection)
enum mpd_error mpd_connection_get_error(const struct mpd_connection *connection)
int mpd_connection_get_fd(const struct mpd_connection *connection)
const char * mpd_connection_get_error_message(const struct mpd_connection *connection)
bool mpd_connection_clear_error(struct mpd_connection *connection)
struct mpd_connection * mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms)
struct mpd_async * mpd_connection_get_async(struct mpd_connection *connection)
void mpd_connection_free(struct mpd_connection *connection)
const unsigned * mpd_connection_get_server_version(const struct mpd_connection *connection)
unsigned mpd_connection_get_server_error_location(const struct mpd_connection *connection)
int mpd_connection_cmp_server_version(const struct mpd_connection *connection, unsigned major, unsigned minor, unsigned patch)