connection.h

Go to the documentation of this file.

/* libmpdclient
   (c) 2003-2019 The Music Player Daemon Project
   This project's homepage is: http://www.musicpd.org
 
   Redistribution and use in source and binary forms, with or without
   modification, are permitted provided that the following conditions
   are met:
 
   - Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 
   - Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 
   - Neither the name of the Music Player Daemon nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef MPD_CONNECTION_H
#define MPD_CONNECTION_H
 
#include "protocol.h"
#include "error.h"
#include "compiler.h"
 
#include <stdbool.h>
 
struct mpd_async;
 
struct mpd_connection;
 
#ifdef __cplusplus
extern "C" {
#endif
 
mpd_malloc
struct mpd_connection *
mpd_connection_new(const char *host, unsigned port, unsigned timeout_ms);
 
mpd_malloc
struct mpd_connection *
mpd_connection_new_async(struct mpd_async *async, const char *welcome);
 
void mpd_connection_free(struct mpd_connection *connection);
 
const struct mpd_settings *
mpd_connection_get_settings(const struct mpd_connection *connection);
 
bool
mpd_connection_set_keepalive(struct mpd_connection *connection,
                 bool keepalive);
 
void mpd_connection_set_timeout(struct mpd_connection *connection,
                unsigned timeout_ms);
 
mpd_pure
int
mpd_connection_get_fd(const struct mpd_connection *connection);
 
mpd_pure
struct mpd_async *
mpd_connection_get_async(struct mpd_connection *connection);
 
mpd_pure
enum mpd_error
mpd_connection_get_error(const struct mpd_connection *connection);
 
mpd_pure
const char *
mpd_connection_get_error_message(const struct mpd_connection *connection);
 
mpd_pure
enum mpd_server_error
mpd_connection_get_server_error(const struct mpd_connection *connection);
 
mpd_pure
unsigned
mpd_connection_get_server_error_location(const struct mpd_connection *connection);
 
mpd_pure
int
mpd_connection_get_system_error(const struct mpd_connection *connection);
 
bool
mpd_connection_clear_error(struct mpd_connection *connection);
 
mpd_pure
const unsigned *
mpd_connection_get_server_version(const struct mpd_connection *connection);
 
mpd_pure
int
mpd_connection_cmp_server_version(const struct mpd_connection *connection,
                  unsigned major, unsigned minor,
                  unsigned patch);
 
#ifdef __cplusplus
}
#endif
 
#endif