diff options
Diffstat (limited to 'src/InputPlugin.hxx')
-rw-r--r-- | src/InputPlugin.hxx | 91 |
1 files changed, 0 insertions, 91 deletions
diff --git a/src/InputPlugin.hxx b/src/InputPlugin.hxx deleted file mode 100644 index 00226d195..000000000 --- a/src/InputPlugin.hxx +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright (C) 2003-2013 The Music Player Daemon Project - * http://www.musicpd.org - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License along - * with this program; if not, write to the Free Software Foundation, Inc., - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - */ - -#ifndef MPD_INPUT_PLUGIN_HXX -#define MPD_INPUT_PLUGIN_HXX - -#include "thread/Mutex.hxx" -#include "thread/Cond.hxx" - -#include <stddef.h> -#include <stdint.h> - -struct config_param; -struct InputStream; -class Error; -struct Tag; - -struct InputPlugin { - typedef int64_t offset_type; - - const char *name; - - /** - * Global initialization. This method is called when MPD starts. - * - * @return true on success, false if the plugin should be - * disabled - */ - bool (*init)(const config_param ¶m, Error &error); - - /** - * Global deinitialization. Called once before MPD shuts - * down (only if init() has returned true). - */ - void (*finish)(void); - - InputStream *(*open)(const char *uri, - Mutex &mutex, Cond &cond, - Error &error); - void (*close)(InputStream *is); - - /** - * Check for errors that may have occurred in the I/O thread. - * May be unimplemented for synchronous plugins. - * - * @return false on error - */ - bool (*check)(InputStream *is, Error &error); - - /** - * Update the public attributes. Call before access. Can be - * nullptr if the plugin always keeps its attributes up to date. - */ - void (*update)(InputStream *is); - - Tag *(*tag)(InputStream *is); - - /** - * Returns true if the next read operation will not block: - * either data is available, or end-of-stream has been - * reached, or an error has occurred. - * - * If this method is unimplemented, then it is assumed that - * reading will never block. - */ - bool (*available)(InputStream *is); - - size_t (*read)(InputStream *is, void *ptr, size_t size, - Error &error); - bool (*eof)(InputStream *is); - bool (*seek)(InputStream *is, offset_type offset, int whence, - Error &error); -}; - -#endif |