libmpdclient: mpd/connection.h Source File

libmpdclient 2.9

- Main Page
- Classes
- Files

- File List
- File Members

connection.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_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_timeout(struct mpd_connection *connection,
147 unsigned timeout_ms);
148
155 mpd_pure
156 int
157 mpd_connection_get_fd(const struct mpd_connection *connection);
158
168 mpd_pure
169 struct mpd_async *
170 mpd_connection_get_async(struct mpd_connection *connection);
171
176 mpd_pure
177 enum mpd_error
178 mpd_connection_get_error(const struct mpd_connection *connection);
179
190 mpd_pure
191 const char *
192 mpd_connection_get_error_message(const struct mpd_connection *connection);
193
199 mpd_pure
200 enum mpd_server_error
201 mpd_connection_get_server_error(const struct mpd_connection *connection);
202
209 mpd_pure
210 unsigned
211 mpd_connection_get_server_error_location(const struct mpd_connection *connection);
212
220 mpd_pure
221 int
222 mpd_connection_get_system_error(const struct mpd_connection *connection);
223
232 bool
233 mpd_connection_clear_error(struct mpd_connection *connection);
234
239 mpd_pure
240 const unsigned *
241 mpd_connection_get_server_version(const struct mpd_connection *connection);
242
249 mpd_pure
250 int
251 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
252 unsigned major, unsigned minor,
253 unsigned patch);
254
255 #ifdef __cplusplus
256 }
257 #endif
258
259 #endif
mpd_connection_get_server_error_location
mpd_pure unsigned mpd_connection_get_server_error_location(const struct mpd_connection *connection)
mpd_connection_get_server_version
mpd_pure const unsigned * mpd_connection_get_server_version(const struct mpd_connection *connection)
mpd_connection_get_system_error
mpd_pure int mpd_connection_get_system_error(const struct mpd_connection *connection)
mpd_connection_get_server_error
mpd_pure enum mpd_server_error mpd_connection_get_server_error(const struct mpd_connection *connection)
mpd_connection_new
mpd_malloc struct mpd_connection * mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms)
mpd_server_error
mpd_server_error
Definition: protocol.h:39
mpd_connection_set_timeout
void mpd_connection_set_timeout(struct mpd_connection *connection, unsigned timeout_ms)
mpd_error
mpd_error
Definition: error.h:39
protocol.h
MPD client library.
error.h
MPD client library.
mpd_connection_cmp_server_version
mpd_pure int mpd_connection_cmp_server_version(const struct mpd_connection *connection, unsigned major, unsigned minor, unsigned patch)
mpd_connection_get_settings
const struct mpd_settings * mpd_connection_get_settings(const struct mpd_connection *connection)
compiler.h
Compiler specific definitions.
mpd_connection_clear_error
bool mpd_connection_clear_error(struct mpd_connection *connection)
mpd_connection_get_error
mpd_pure enum mpd_error mpd_connection_get_error(const struct mpd_connection *connection)
mpd_connection_new_async
mpd_malloc struct mpd_connection * mpd_connection_new_async(struct mpd_async *async, const char *welcome)
mpd_connection_free
void mpd_connection_free(struct mpd_connection *connection)
mpd_connection
Definition: connection.h:48
mpd_connection_get_async
mpd_pure struct mpd_async * mpd_connection_get_async(struct mpd_connection *connection)
mpd_connection_get_error_message
mpd_pure const char * mpd_connection_get_error_message(const struct mpd_connection *connection)
mpd_async
mpd_connection_get_fd
mpd_pure int mpd_connection_get_fd(const struct mpd_connection *connection)
mpd_settings