libmpdclient  2.7
mpd/entity.h
Go to the documentation of this file.
00001 /* libmpdclient
00002    (c) 2003-2010 The Music Player Daemon Project
00003    This project's homepage is: http://www.musicpd.org
00004 
00005    Redistribution and use in source and binary forms, with or without
00006    modification, are permitted provided that the following conditions
00007    are met:
00008 
00009    - Redistributions of source code must retain the above copyright
00010    notice, this list of conditions and the following disclaimer.
00011 
00012    - Redistributions in binary form must reproduce the above copyright
00013    notice, this list of conditions and the following disclaimer in the
00014    documentation and/or other materials provided with the distribution.
00015 
00016    - Neither the name of the Music Player Daemon nor the names of its
00017    contributors may be used to endorse or promote products derived from
00018    this software without specific prior written permission.
00019 
00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00023    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 */
00032 
00039 #ifndef MPD_ENTITY_H
00040 #define MPD_ENTITY_H
00041 
00042 #include <mpd/song.h>
00043 #include <mpd/directory.h>
00044 #include <mpd/client.h>
00045 #include <mpd/compiler.h>
00046 
00047 struct mpd_pair;
00048 
00052 enum mpd_entity_type {
00057         MPD_ENTITY_TYPE_UNKNOWN,
00058 
00062         MPD_ENTITY_TYPE_DIRECTORY,
00063 
00067         MPD_ENTITY_TYPE_SONG,
00068 
00072         MPD_ENTITY_TYPE_PLAYLIST,
00073 };
00074 
00081 struct mpd_entity;
00082 
00083 #ifdef __cplusplus
00084 extern "C" {
00085 #endif
00086 
00090 void
00091 mpd_entity_free(struct mpd_entity *entity);
00092 
00096 mpd_pure
00097 enum mpd_entity_type
00098 mpd_entity_get_type(const struct mpd_entity *entity);
00099 
00107 mpd_pure
00108 const struct mpd_directory *
00109 mpd_entity_get_directory(const struct mpd_entity *entity);
00110 
00118 mpd_pure
00119 const struct mpd_song *
00120 mpd_entity_get_song(const struct mpd_entity *entity);
00121 
00129 mpd_pure
00130 const struct mpd_playlist *
00131 mpd_entity_get_playlist(const struct mpd_entity *entity);
00132 
00139 mpd_malloc
00140 struct mpd_entity *
00141 mpd_entity_begin(const struct mpd_pair *pair);
00142 
00151 bool
00152 mpd_entity_feed(struct mpd_entity *entity, const struct mpd_pair *pair);
00153 
00160 mpd_malloc
00161 struct mpd_entity *
00162 mpd_recv_entity(struct mpd_connection *connection);
00163 
00164 #ifdef __cplusplus
00165 }
00166 #endif
00167 
00168 #endif