message.h

Go to the documentation of this file.

/* libmpdclient
   (c) 2003-2015 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.

   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_MESSAGE_H
#define MPD_MESSAGE_H

#include <mpd/recv.h>
#include <mpd/compiler.h>

#include <stdbool.h>

struct mpd_pair;
struct mpd_message;
struct mpd_connection;

#ifdef __cplusplus
extern "C" {
#endif

mpd_malloc
struct mpd_message *
mpd_message_begin(const struct mpd_pair *pair);

bool
mpd_message_feed(struct mpd_message *output, const struct mpd_pair *pair);

void
mpd_message_free(struct mpd_message *message);

mpd_pure
const char *
mpd_message_get_channel(const struct mpd_message *message);

mpd_pure
const char *
mpd_message_get_text(const struct mpd_message *message);

bool
mpd_send_subscribe(struct mpd_connection *connection, const char *channel);

bool
mpd_run_subscribe(struct mpd_connection *connection, const char *channel);

bool
mpd_send_unsubscribe(struct mpd_connection *connection, const char *channel);

bool
mpd_run_unsubscribe(struct mpd_connection *connection, const char *channel);

bool
mpd_send_send_message(struct mpd_connection *connection,
              const char *channel, const char *text);

bool
mpd_run_send_message(struct mpd_connection *connection,
             const char *channel, const char *text);

bool
mpd_send_read_messages(struct mpd_connection *connection);

mpd_malloc
struct mpd_message *
mpd_recv_message(struct mpd_connection *connection);

bool
mpd_send_channels(struct mpd_connection *connection);

mpd_malloc
static inline struct mpd_pair *
mpd_recv_channel_pair(struct mpd_connection *connection)
{
    return mpd_recv_pair_named(connection, "channel");
}

#ifdef __cplusplus
}
#endif

#endif