code.delx.au - pulseaudio/blob - src/pulsecore/shared.h

   1 #ifndef foosharedshfoo
   2 #define foosharedshfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <pulsecore/core.h>
  26 #include <pulsecore/strbuf.h>
  27
  28 /* The shared property subsystem is to be used to share data between
  29  * modules. Consider them to be kind of "global" variables for a
  30  * core. Why not use the hashmap functions directly? The hashmap
  31  * functions copy neither the key nor value, while this property
  32  * system copies the key. Users of this system have to think about
  33  * reference counting themselves. */
  34
  35 /* Note: please don't confuse this with the proplist framework in
  36  * pulse/proplist.[ch]! */
  37
  38 /* Return a pointer to the value of the specified shared property. */
  39 void* pa_shared_get(pa_core *c, const char *name);
  40
  41 /* Set the shared property 'name' to 'data'. This function fails in
  42  * case a property by this name already exists. The property data is
  43  * not copied or reference counted. This is the caller's job. */
  44 int pa_shared_set(pa_core *c, const char *name, void *data);
  45
  46 /* Remove the specified shared property. Return non-zero on failure */
  47 int pa_shared_remove(pa_core *c, const char *name);
  48
  49 /* A combination of pa_shared_remove() and pa_shared_set() */
  50 int pa_shared_replace(pa_core *c, const char *name, void *data);
  51
  52 /* Dump the current set of shared properties */
  53 void pa_shared_dump(pa_core *c, pa_strbuf *s);
  54
  55 #endif