src/pulsecore/hook-list.h

   1 #ifndef foohooklistfoo
   2 #define foohooklistfoo
   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/llist.h>
  26
  27 typedef struct pa_hook_slot pa_hook_slot;
  28 typedef struct pa_hook pa_hook;
  29
  30 typedef enum pa_hook_result {
  31     PA_HOOK_OK = 0,
  32     PA_HOOK_STOP = 1,
  33     PA_HOOK_CANCEL = -1
  34 } pa_hook_result_t;
  35
  36 typedef enum pa_hook_priority {
  37     PA_HOOK_EARLY = -100,
  38     PA_HOOK_NORMAL = 0,
  39     PA_HOOK_LATE = 100
  40 } pa_hook_priority_t;
  41
  42 typedef pa_hook_result_t (*pa_hook_cb_t)(
  43         void *hook_data,
  44         void *call_data,
  45         void *slot_data);
  46
  47 struct pa_hook_slot {
  48     pa_bool_t dead;
  49     pa_hook *hook;
  50     pa_hook_priority_t priority;
  51     pa_hook_cb_t callback;
  52     void *data;
  53     PA_LLIST_FIELDS(pa_hook_slot);
  54 };
  55
  56 struct pa_hook {
  57     PA_LLIST_HEAD(pa_hook_slot, slots);
  58     int n_firing, n_dead;
  59
  60     void *data;
  61 };
  62
  63 void pa_hook_init(pa_hook *hook, void *data);
  64 void pa_hook_done(pa_hook *hook);
  65
  66 pa_hook_slot* pa_hook_connect(pa_hook *hook, pa_hook_priority_t prio, pa_hook_cb_t cb, void *data);
  67 void pa_hook_slot_free(pa_hook_slot *slot);
  68
  69 pa_hook_result_t pa_hook_fire(pa_hook *hook, void *data);
  70
  71 pa_bool_t pa_hook_is_firing(pa_hook *hook);
  72
  73 #endif