src/pulse/subscribe.h

   1 #ifndef foosubscribehfoo
   2 #define foosubscribehfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   8
   9   Copyright 2004-2006 Lennart Poettering
  10   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
  11
  12   PulseAudio is free software; you can redistribute it and/or modify
  13   it under the terms of the GNU Lesser General Public License as published
  14   by the Free Software Foundation; either version 2 of the License,
  15   or (at your option) any later version.
  16
  17   PulseAudio is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with PulseAudio; if not, write to the Free Software
  24   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  25   USA.
  26 ***/
  27
  28 #include <inttypes.h>
  29
  30 #include <pulse/def.h>
  31 #include <pulse/context.h>
  32 #include <pulse/cdecl.h>
  33
  34 /** \page subscribe Event Subscription
  35  *
  36  * \section overv_sec Overview
  37  *
  38  * The application can be notified, asynchronously, whenever the internal
  39  * layout of the server changes. Possible notifications are desribed in the
  40  * \ref pa_subscription_event_type and \ref pa_subscription_mask
  41  * enumerations.
  42  *
  43  * The application sets the notification mask using pa_context_subscribe()
  44  * and the function that will be called whenever a notification occurs using
  45  * pa_context_set_subscribe_callback().
  46  */
  47
  48 /** \file
  49  * Daemon introspection event subscription subsystem. */
  50
  51 PA_C_DECL_BEGIN
  52
  53 /** Subscription event callback prototype */
  54 typedef void (*pa_context_subscribe_cb_t)(pa_context *c, pa_subscription_event_type_t t, uint32_t idx, void *userdata);
  55
  56 /** Enable event notification */
  57 pa_operation* pa_context_subscribe(pa_context *c, pa_subscription_mask_t m, pa_context_success_cb_t cb, void *userdata);
  58
  59 /** Set the context specific call back function that is called whenever the state of the daemon changes */
  60 void pa_context_set_subscribe_callback(pa_context *c, pa_context_subscribe_cb_t cb, void *userdata);
  61
  62 PA_C_DECL_END
  63
  64 #endif