operation.h 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. #ifndef foooperationhfoo
  2. #define foooperationhfoo
  3. /***
  4. This file is part of PulseAudio.
  5. Copyright 2004-2006 Lennart Poettering
  6. PulseAudio is free software; you can redistribute it and/or modify
  7. it under the terms of the GNU Lesser General Public License as published
  8. by the Free Software Foundation; either version 2.1 of the License,
  9. or (at your option) any later version.
  10. PulseAudio is distributed in the hope that it will be useful, but
  11. WITHOUT ANY WARRANTY; without even the implied warranty of
  12. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13. General Public License for more details.
  14. You should have received a copy of the GNU Lesser General Public License
  15. along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
  16. ***/
  17. #include <pulse/cdecl.h>
  18. #include <pulse/def.h>
  19. #include <pulse/version.h>
  20. /** \file
  21. * Asynchronous operations */
  22. PA_C_DECL_BEGIN
  23. /** An asynchronous operation object */
  24. typedef struct pa_operation pa_operation;
  25. /** A callback for operation state changes */
  26. typedef void (*pa_operation_notify_cb_t) (pa_operation *o, void *userdata);
  27. /** Increase the reference count by one */
  28. pa_operation *pa_operation_ref(pa_operation *o);
  29. /** Decrease the reference count by one */
  30. void pa_operation_unref(pa_operation *o);
  31. /** Cancel the operation. Beware! This will not necessarily cancel the
  32. * execution of the operation on the server side. However it will make
  33. * sure that the callback associated with this operation will not be
  34. * called anymore, effectively disabling the operation from the client
  35. * side's view. */
  36. void pa_operation_cancel(pa_operation *o);
  37. /** Return the current status of the operation */
  38. pa_operation_state_t pa_operation_get_state(pa_operation *o);
  39. /** Set the callback function that is called when the operation state
  40. * changes. Usually this is not necessary, since the functions that
  41. * create pa_operation objects already take a callback that is called
  42. * when the operation finishes. Registering a state change callback is
  43. * mainly useful, if you want to get called back also if the operation
  44. * gets cancelled. \since 4.0 */
  45. void pa_operation_set_state_callback(pa_operation *o, pa_operation_notify_cb_t cb, void *userdata);
  46. PA_C_DECL_END
  47. #endif