aboutsummaryrefslogtreecommitdiff
path: root/src/InputStream.hxx
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2013-01-24 19:14:40 +0100
committerMax Kellermann <max@duempel.org>2013-01-26 01:24:01 +0100
commit0273cd44b0b50d5d320ce88cc1472e0d8ee8e529 (patch)
tree7c493850ab07deddd637ca0b5e8b3476e40a68fc /src/InputStream.hxx
parent3203a7dd8ce8db6afcc54d68d63b4f4af7dc4c7f (diff)
input_stream: forward-declare the struct
Hide the definition from C code, to prepare the transition to C++.
Diffstat (limited to 'src/InputStream.hxx')
-rw-r--r--src/InputStream.hxx102
1 files changed, 102 insertions, 0 deletions
diff --git a/src/InputStream.hxx b/src/InputStream.hxx
new file mode 100644
index 00000000..8a82888f
--- /dev/null
+++ b/src/InputStream.hxx
@@ -0,0 +1,102 @@
+/*
+ * 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_STREAM_HXX
+#define MPD_INPUT_STREAM_HXX
+
+#include "input_stream.h"
+#include "check.h"
+#include "gcc.h"
+
+#include <glib.h>
+
+struct input_stream {
+ /**
+ * the plugin which implements this input stream
+ */
+ const struct input_plugin *plugin;
+
+ /**
+ * The absolute URI which was used to open this stream. May
+ * be NULL if this is unknown.
+ */
+ char *uri;
+
+ /**
+ * A mutex that protects the mutable attributes of this object
+ * and its implementation. It must be locked before calling
+ * any of the public methods.
+ *
+ * This object is allocated by the client, and the client is
+ * responsible for freeing it.
+ */
+ GMutex *mutex;
+
+ /**
+ * A cond that gets signalled when the state of this object
+ * changes from the I/O thread. The client of this object may
+ * wait on it. Optional, may be NULL.
+ *
+ * This object is allocated by the client, and the client is
+ * responsible for freeing it.
+ */
+ GCond *cond;
+
+ /**
+ * indicates whether the stream is ready for reading and
+ * whether the other attributes in this struct are valid
+ */
+ bool ready;
+
+ /**
+ * if true, then the stream is fully seekable
+ */
+ bool seekable;
+
+ /**
+ * the size of the resource, or -1 if unknown
+ */
+ goffset size;
+
+ /**
+ * the current offset within the stream
+ */
+ goffset offset;
+
+ /**
+ * the MIME content type of the resource, or NULL if unknown
+ */
+ char *mime;
+};
+
+gcc_nonnull(1)
+static inline void
+input_stream_lock(struct input_stream *is)
+{
+ g_mutex_lock(is->mutex);
+}
+
+gcc_nonnull(1)
+static inline void
+input_stream_unlock(struct input_stream *is)
+{
+ g_mutex_unlock(is->mutex);
+}
+
+#endif