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