libmpdclient  2.19
entity.h
Go to the documentation of this file.
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  - Neither the name of the Music Player Daemon nor the names of its
17  contributors may be used to endorse or promote products derived from
18  this software without specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
24  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32 
39 #ifndef MPD_ENTITY_H
40 #define MPD_ENTITY_H
41 
42 #include "song.h"
43 #include "directory.h"
44 #include "compiler.h"
45 
46 struct mpd_pair;
47 
57 
62 
67 
72 };
73 
80 struct mpd_entity;
81 
82 #ifdef __cplusplus
83 extern "C" {
84 #endif
85 
89 void
90 mpd_entity_free(struct mpd_entity *entity);
91 
95 mpd_pure
96 enum mpd_entity_type
97 mpd_entity_get_type(const struct mpd_entity *entity);
98 
106 mpd_pure
107 const struct mpd_directory *
108 mpd_entity_get_directory(const struct mpd_entity *entity);
109 
117 mpd_pure
118 const struct mpd_song *
119 mpd_entity_get_song(const struct mpd_entity *entity);
120 
128 mpd_pure
129 const struct mpd_playlist *
130 mpd_entity_get_playlist(const struct mpd_entity *entity);
131 
138 mpd_malloc
139 struct mpd_entity *
140 mpd_entity_begin(const struct mpd_pair *pair);
141 
150 bool
151 mpd_entity_feed(struct mpd_entity *entity, const struct mpd_pair *pair);
152 
159 mpd_malloc
160 struct mpd_entity *
161 mpd_recv_entity(struct mpd_connection *connection);
162 
163 #ifdef __cplusplus
164 }
165 #endif
166 
167 #endif
void mpd_entity_free(struct mpd_entity *entity)
enum mpd_entity_type mpd_entity_get_type(const struct mpd_entity *entity)
struct mpd_entity * mpd_recv_entity(struct mpd_connection *connection)
MPD client library.
const struct mpd_directory * mpd_entity_get_directory(const struct mpd_entity *entity)
struct mpd_entity * mpd_entity_begin(const struct mpd_pair *pair)
MPD client library.
mpd_entity_type
Definition: entity.h:51
bool mpd_entity_feed(struct mpd_entity *entity, const struct mpd_pair *pair)
const struct mpd_playlist * mpd_entity_get_playlist(const struct mpd_entity *entity)
Definition: song.h:49
const struct mpd_song * mpd_entity_get_song(const struct mpd_entity *entity)
Definition: pair.h:41