src/pulse/subscribe.h

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