1 /* libmpdclient 2 (c) 2003-2019 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 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR 20 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 21 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 22 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 23 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 24 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 25 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 26 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /*! \file 30 * \brief MPD client library 31 * 32 * Receiving response lines from MPD. 33 * 34 * Do not include this header directly. Use mpd/client.h instead. 35 */ 36 37 #ifndef MPD_RECV_H 38 #define MPD_RECV_H 39 40 #include "compiler.h" 41 42 #include <stdbool.h> 43 #include <stddef.h> 44 45 struct mpd_pair; 46 struct mpd_connection; 47 48 #ifdef __cplusplus 49 extern "C" { 50 #endif 51 52 /** 53 * Reads the binary data response from the server. 54 * The size and binary pair must be already read from the input buffer. 55 * 56 * The caller must allocate length bytes of memory for data. 57 * 58 * @return true on success 59 * 60 * @since libmpdclient 2.17 61 */ 62 bool 63 mpd_recv_binary(struct mpd_connection *connection, void *data, size_t length); 64 65 /** 66 * Reads the next #mpd_pair from the server. Returns NULL if there 67 * are no more pairs. 68 * 69 * The caller must dispose the pair with either mpd_return_pair() or 70 * mpd_enqueue_pair(). 71 */ 72 mpd_malloc 73 struct mpd_pair * 74 mpd_recv_pair(struct mpd_connection *connection); 75 76 /** 77 * Same as mpd_recv_pair(), but discards all pairs not matching the 78 * specified name. 79 */ 80 mpd_malloc 81 struct mpd_pair * 82 mpd_recv_pair_named(struct mpd_connection *connection, const char *name); 83 84 /** 85 * Indicates that the pair object is not needed anymore, and can be 86 * freed. You must free the previous #mpd_pair object before calling 87 * mpd_recv_pair() again. 88 */ 89 void 90 mpd_return_pair(struct mpd_connection *connection, struct mpd_pair *pair); 91 92 /** 93 * Unreads a #mpd_pair. You may unread only the one pair you just got 94 * from mpd_recv_pair(). Unreading the "NULL" pair is allowed, to 95 * allow you to call mpd_recv_pair() again at the end of a response. 96 */ 97 void 98 mpd_enqueue_pair(struct mpd_connection *connection, struct mpd_pair *pair); 99 100 #ifdef __cplusplus 101 } 102 #endif 103 104 #endif 105