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