mpd/connection.h

Go to the documentation of this file.
00001 /* libmpdclient
00002    (c) 2003-2009 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 
00095 mpd_malloc
00096 struct mpd_connection *
00097 mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
00098 
00112 mpd_malloc
00113 struct mpd_connection *
00114 mpd_connection_new_async(struct mpd_async *async, const char *welcome);
00115 
00121 void mpd_connection_free(struct mpd_connection *connection);
00122 
00135 void mpd_connection_set_timeout(struct mpd_connection *connection,
00136                                 unsigned timeout_ms);
00137 
00144 mpd_pure
00145 int
00146 mpd_connection_get_fd(const struct mpd_connection *connection);
00147 
00157 mpd_pure
00158 struct mpd_async *
00159 mpd_connection_get_async(struct mpd_connection *connection);
00160 
00165 mpd_pure
00166 enum mpd_error
00167 mpd_connection_get_error(const struct mpd_connection *connection);
00168 
00179 mpd_pure
00180 const char *
00181 mpd_connection_get_error_message(const struct mpd_connection *connection);
00182 
00188 mpd_pure
00189 enum mpd_server_error
00190 mpd_connection_get_server_error(const struct mpd_connection *connection);
00191 
00199 mpd_pure
00200 int
00201 mpd_connection_get_system_error(const struct mpd_connection *connection);
00202 
00211 bool
00212 mpd_connection_clear_error(struct mpd_connection *connection);
00213 
00218 mpd_pure
00219 const unsigned *
00220 mpd_connection_get_server_version(const struct mpd_connection *connection);
00221 
00228 mpd_pure
00229 int
00230 mpd_connection_cmp_server_version(const struct mpd_connection *connection,
00231                                   unsigned major, unsigned minor,
00232                                   unsigned patch);
00233 
00234 #ifdef __cplusplus
00235 }
00236 #endif
00237 
00238 #endif

Generated on Tue Apr 13 16:33:29 2010 for libmpdclient by  doxygen 1.4.7