libmpdclient 2.10

mpd/connection.h

Go to the documentation of this file.
00001 /* libmpdclient
00002    (c) 2003-2015 The Music Player Daemon Project
00003    This project's homepage is: http://www.musicpd.org
00004 
00005    Redistribution and use in source and binary forms, with or without
00006    modification, are permitted provided that the following conditions
00007    are met:
00008 
00009    - Redistributions of source code must retain the above copyright
00010    notice, this list of conditions and the following disclaimer.
00011 
00012    - Redistributions in binary form must reproduce the above copyright
00013    notice, this list of conditions and the following disclaimer in the
00014    documentation and/or other materials provided with the distribution.
00015 
00016    - Neither the name of the Music Player Daemon nor the names of its
00017    contributors may be used to endorse or promote products derived from
00018    this software without specific prior written permission.
00019 
00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00023    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 */
00032 
00039 #ifndef MPD_CONNECTION_H
00040 #define MPD_CONNECTION_H
00041 
00042 #include <mpd/protocol.h>
00043 #include <mpd/error.h>
00044 #include <mpd/compiler.h>
00045 
00046 #include <stdbool.h>
00047 
00048 struct mpd_async;
00049 
00072 struct mpd_connection;
00073 
00074 #ifdef __cplusplus
00075 extern "C" {
00076 #endif
00077 
00099 mpd_malloc
00100 struct mpd_connection *
00101 mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
00102 
00116 mpd_malloc
00117 struct mpd_connection *
00118 mpd_connection_new_async(struct mpd_async *async, const char *welcome);
00119 
00125 void mpd_connection_free(struct mpd_connection *connection);
00126 
00131 const struct mpd_settings *
00132 mpd_connection_get_settings(const struct mpd_connection *connection);
00133 
00146 void mpd_connection_set_keepalive(struct mpd_connection *connection,
00147                                   bool keepalive);
00148 
00161 void mpd_connection_set_timeout(struct mpd_connection *connection,
00162                                 unsigned timeout_ms);
00163 
00170 mpd_pure
00171 int
00172 mpd_connection_get_fd(const struct mpd_connection *connection);
00173 
00183 mpd_pure
00184 struct mpd_async *
00185 mpd_connection_get_async(struct mpd_connection *connection);
00186 
00191 mpd_pure
00192 enum mpd_error
00193 mpd_connection_get_error(const struct mpd_connection *connection);
00194 
00205 mpd_pure
00206 const char *
00207 mpd_connection_get_error_message(const struct mpd_connection *connection);
00208 
00214 mpd_pure
00215 enum mpd_server_error
00216 mpd_connection_get_server_error(const struct mpd_connection *connection);
00217 
00224 mpd_pure
00225 unsigned
00226 mpd_connection_get_server_error_location(const struct mpd_connection *connection);
00227 
00235 mpd_pure
00236 int
00237 mpd_connection_get_system_error(const struct mpd_connection *connection);
00238 
00247 bool
00248 mpd_connection_clear_error(struct mpd_connection *connection);
00249 
00254 mpd_pure
00255 const unsigned *
00256 mpd_connection_get_server_version(const struct mpd_connection *connection);
00257 
00264 mpd_pure
00265 int
00266 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
00267                                   unsigned major, unsigned minor,
00268                                   unsigned patch);
00269 
00270 #ifdef __cplusplus
00271 }
00272 #endif
00273 
00274 #endif