]> code.delx.au - pulseaudio/blobdiff - src/pulse/operation.h
pulse: Add pa_operation_set_state_callback() API
[pulseaudio] / src / pulse / operation.h
index 97d1c6b8e71c863ed11bd2fafa5c30b9a695bf75..4d5aa2be9c7cf908724623d2fe2377a87d43c40d 100644 (file)
@@ -1,8 +1,6 @@
 #ifndef foooperationhfoo
 #define foooperationhfoo
 
-/* $Id$ */
-
 /***
   This file is part of PulseAudio.
 
@@ -10,7 +8,7 @@
 
   PulseAudio is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
-  by the Free Software Foundation; either version 2 of the License,
+  by the Free Software Foundation; either version 2.1 of the License,
   or (at your option) any later version.
 
   PulseAudio is distributed in the hope that it will be useful, but
@@ -26,6 +24,7 @@
 
 #include <pulse/cdecl.h>
 #include <pulse/def.h>
+#include <pulse/version.h>
 
 /** \file
  * Asynchronous operations */
@@ -35,18 +34,29 @@ PA_C_DECL_BEGIN
 /** An asynchronous operation object */
 typedef struct pa_operation pa_operation;
 
+/** A callback for operation state changes */
+typedef void (*pa_operation_notify_cb_t) (pa_operation *o, void *userdata);
+
 /** Increase the reference count by one */
 pa_operation *pa_operation_ref(pa_operation *o);
 
 /** Decrease the reference count by one */
 void pa_operation_unref(pa_operation *o);
 
-/** Cancel the operation. Beware! This will not necessarily cancel the execution of the operation on the server side. */
+/** Cancel the operation. Beware! This will not necessarily cancel the
+ * execution of the operation on the server side. However it will make
+ * sure that the callback associated with this operation will not be
+ * called anymore, effectively disabling the operation from the client
+ * side's view. */
 void pa_operation_cancel(pa_operation *o);
 
 /** Return the current status of the operation */
 pa_operation_state_t pa_operation_get_state(pa_operation *o);
 
+/** Set the callback function that is called when the operation
+ * is canceled due to disconnection. \since 4.0 */
+void pa_operation_set_state_callback(pa_operation *o, pa_operation_notify_cb_t cb, void *userdata);
+
 PA_C_DECL_END
 
 #endif