src/pulsecore/mutex.h

   1 #ifndef foopulsemutexhfoo
   2 #define foopulsemutexhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 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
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, 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
  20   License 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/macro.h>
  26 #include <pulsecore/atomic.h>
  27
  28 typedef struct pa_mutex pa_mutex;
  29
  30 /* Please think twice before enabling priority inheritance. This is no
  31  * magic wand! Use it only when the potentially priorized threads are
  32  * good candidates for it. Don't use this blindly! Also, note that
  33  * only very few operating systems actually implement this, hence this
  34  * is merely a hint. */
  35 pa_mutex* pa_mutex_new(pa_bool_t recursive, pa_bool_t inherit_priority);
  36
  37 void pa_mutex_free(pa_mutex *m);
  38 void pa_mutex_lock(pa_mutex *m);
  39 pa_bool_t pa_mutex_try_lock(pa_mutex *m);
  40 void pa_mutex_unlock(pa_mutex *m);
  41
  42 typedef struct pa_cond pa_cond;
  43
  44 pa_cond *pa_cond_new(void);
  45 void pa_cond_free(pa_cond *c);
  46 void pa_cond_signal(pa_cond *c, int broadcast);
  47 int pa_cond_wait(pa_cond *c, pa_mutex *m);
  48
  49 /* Static mutexes are basically just atomically updated pointers to pa_mutex objects */
  50
  51 typedef struct pa_static_mutex {
  52     pa_atomic_ptr_t ptr;
  53 } pa_static_mutex;
  54
  55 #define PA_STATIC_MUTEX_INIT { PA_ATOMIC_PTR_INIT(NULL) }
  56
  57 pa_mutex* pa_static_mutex_get(pa_static_mutex *m, pa_bool_t recursive, pa_bool_t inherit_priority);
  58
  59 #endif