diff options
| author | Pierre Ossman <ossman@cendio.se> | 2006-04-09 19:31:09 +0000 |
|---|---|---|
| committer | Pierre Ossman <ossman@cendio.se> | 2006-04-09 19:31:09 +0000 |
| commit | a6ce5c4b1d82870f5db7063680698cebb4ffe156 (patch) | |
| tree | f60708ee269c4f11f0a7017896c8a63507166a5a /src/polyp/subscribe.h | |
| parent | a74253606f4f5556e58cb12336d8900dd73226cc (diff) | |
Big documentation update. Describe the client API in a more tutorial like
manner.
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@667 fefdeb5f-60dc-0310-8127-8f9354f1896f
Diffstat (limited to 'src/polyp/subscribe.h')
| -rw-r--r-- | src/polyp/subscribe.h | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/src/polyp/subscribe.h b/src/polyp/subscribe.h index 5301739a..75b4696f 100644 --- a/src/polyp/subscribe.h +++ b/src/polyp/subscribe.h @@ -28,11 +28,22 @@ #include <polyp/context.h> #include <polyp/cdecl.h> +/** \page subscribe Event subscription + * + * \section overv_sec Overview + * + * The application can be notified, asynchronously, whenever the internal + * layout of the server changes. Possible notifications are desribed in the + * \ref pa_subscription_event_type and \ref pa_subscription_mask + * enumerations. + * + * The application sets the notification mask using pa_context_subscribe() + * and the function that will be called whenever a notification occurs using + * pa_context_set_subscribe_callback(). + */ + /** \file - * Daemon introspection event subscription subsystem. Use this - * to be notified whenever the internal layout of daemon changes: - * i.e. entities such as sinks or sources are create, removed or - * modified. */ + * Daemon introspection event subscription subsystem. */ PA_C_DECL_BEGIN |