libmpdclient  2.17
entity.h
Go to the documentation of this file.
1 /* libmpdclient
2  (c) 2003-2018 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 "client.h"
45 #include "compiler.h"
46 
47 struct mpd_pair;
48 
58 
63 
68 
73 };
74 
81 struct mpd_entity;
82 
83 #ifdef __cplusplus
84 extern "C" {
85 #endif
86 
90 void
91 mpd_entity_free(struct mpd_entity *entity);
92 
96 mpd_pure
97 enum mpd_entity_type
98 mpd_entity_get_type(const struct mpd_entity *entity);
99 
107 mpd_pure
108 const struct mpd_directory *
109 mpd_entity_get_directory(const struct mpd_entity *entity);
110 
118 mpd_pure
119 const struct mpd_song *
120 mpd_entity_get_song(const struct mpd_entity *entity);
121 
129 mpd_pure
130 const struct mpd_playlist *
131 mpd_entity_get_playlist(const struct mpd_entity *entity);
132 
139 mpd_malloc
140 struct mpd_entity *
141 mpd_entity_begin(const struct mpd_pair *pair);
142 
151 bool
152 mpd_entity_feed(struct mpd_entity *entity, const struct mpd_pair *pair);
153 
160 mpd_malloc
161 struct mpd_entity *
162 mpd_recv_entity(struct mpd_connection *connection);
163 
164 #ifdef __cplusplus
165 }
166 #endif
167 
168 #endif
void mpd_entity_free(struct mpd_entity *entity)
MPD client library.
mpd_pure const struct mpd_playlist * mpd_entity_get_playlist(const struct mpd_entity *entity)
mpd_pure enum mpd_entity_type mpd_entity_get_type(const struct mpd_entity *entity)
Compiler specific definitions.
mpd_malloc struct mpd_entity * mpd_entity_begin(const struct mpd_pair *pair)
MPD client library.
mpd_entity_type
Definition: entity.h:52
bool mpd_entity_feed(struct mpd_entity *entity, const struct mpd_pair *pair)
mpd_malloc struct mpd_entity * mpd_recv_entity(struct mpd_connection *connection)
mpd_pure const struct mpd_song * mpd_entity_get_song(const struct mpd_entity *entity)
mpd_pure const struct mpd_directory * mpd_entity_get_directory(const struct mpd_entity *entity)
Definition: song.h:49
MPD client library.
Definition: pair.h:41