summaryrefslogtreecommitdiffstats
path: root/src/pulsecore/shared.h
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2008-08-01 02:10:54 +0300
committerLennart Poettering <lennart@poettering.net>2008-08-01 02:13:41 +0300
commitd36c5c97e53ac8865971bdd34ea27bf11bde49e1 (patch)
tree117396c080997486ccbd815bf11b9bc42d2eaf99 /src/pulsecore/shared.h
parentedc56a7f7a993aa60b979a4093e39f66e7f7a8c8 (diff)
rename props.[ch] to shared.[ch]
Diffstat (limited to 'src/pulsecore/shared.h')
-rw-r--r--src/pulsecore/shared.h61
1 files changed, 61 insertions, 0 deletions
diff --git a/src/pulsecore/shared.h b/src/pulsecore/shared.h
new file mode 100644
index 00000000..dd3f94e2
--- /dev/null
+++ b/src/pulsecore/shared.h
@@ -0,0 +1,61 @@
+#ifndef foosharedshfoo
+#define foosharedshfoo
+
+/***
+ This file is part of PulseAudio.
+
+ Copyright 2004-2006 Lennart Poettering
+
+ PulseAudio is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ PulseAudio 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 Lesser General Public License
+ along with PulseAudio; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ USA.
+***/
+
+#include <pulsecore/core.h>
+#include <pulsecore/strbuf.h>
+
+/* The shared property subsystem is to be used to share data between
+ * modules. Consider them to be kind of "global" variables for a
+ * core. Why not use the hashmap functions directly? The hashmap
+ * functions copy neither the key nor value, while this property
+ * system copies the key. Users of this system have to think about
+ * reference counting themselves. */
+
+/* Note: please don't confuse this with the proplist framework in
+ * pulse/proplist.[ch]! */
+
+/* Return a pointer to the value of the specified shared property. */
+void* pa_shared_get(pa_core *c, const char *name);
+
+/* Set the shared property 'name' to 'data'. This function fails in
+ * case a property by this name already exists. The property data is
+ * not copied or reference counted. This is the caller's job. */
+int pa_shared_set(pa_core *c, const char *name, void *data);
+
+/* Remove the specified shared property. Return non-zero on failure */
+int pa_shared_remove(pa_core *c, const char *name);
+
+/* A combination of pa_shared_remove() and pa_shared_set() */
+int pa_shared_replace(pa_core *c, const char *name, void *data);
+
+/* Free all memory used by the shared property system */
+void pa_shared_cleanup(pa_core *c);
+
+/* Initialize the shared property system */
+void pa_shared_init(pa_core *c);
+
+/* Dump the current set of shared properties */
+void pa_shared_dump(pa_core *c, pa_strbuf *s);
+
+#endif