153a5a1b3Sopenharmony_ci#ifndef foooperationhfoo
253a5a1b3Sopenharmony_ci#define foooperationhfoo
353a5a1b3Sopenharmony_ci
453a5a1b3Sopenharmony_ci/***
553a5a1b3Sopenharmony_ci  This file is part of PulseAudio.
653a5a1b3Sopenharmony_ci
753a5a1b3Sopenharmony_ci  Copyright 2004-2006 Lennart Poettering
853a5a1b3Sopenharmony_ci
953a5a1b3Sopenharmony_ci  PulseAudio is free software; you can redistribute it and/or modify
1053a5a1b3Sopenharmony_ci  it under the terms of the GNU Lesser General Public License as published
1153a5a1b3Sopenharmony_ci  by the Free Software Foundation; either version 2.1 of the License,
1253a5a1b3Sopenharmony_ci  or (at your option) any later version.
1353a5a1b3Sopenharmony_ci
1453a5a1b3Sopenharmony_ci  PulseAudio is distributed in the hope that it will be useful, but
1553a5a1b3Sopenharmony_ci  WITHOUT ANY WARRANTY; without even the implied warranty of
1653a5a1b3Sopenharmony_ci  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1753a5a1b3Sopenharmony_ci  General Public License for more details.
1853a5a1b3Sopenharmony_ci
1953a5a1b3Sopenharmony_ci  You should have received a copy of the GNU Lesser General Public License
2053a5a1b3Sopenharmony_ci  along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
2153a5a1b3Sopenharmony_ci***/
2253a5a1b3Sopenharmony_ci
2353a5a1b3Sopenharmony_ci#include <pulse/cdecl.h>
2453a5a1b3Sopenharmony_ci#include <pulse/def.h>
2553a5a1b3Sopenharmony_ci#include <pulse/version.h>
2653a5a1b3Sopenharmony_ci
2753a5a1b3Sopenharmony_ci/** \file
2853a5a1b3Sopenharmony_ci * Asynchronous operations */
2953a5a1b3Sopenharmony_ci
3053a5a1b3Sopenharmony_ciPA_C_DECL_BEGIN
3153a5a1b3Sopenharmony_ci
3253a5a1b3Sopenharmony_ci/** An asynchronous operation object */
3353a5a1b3Sopenharmony_citypedef struct pa_operation pa_operation;
3453a5a1b3Sopenharmony_ci
3553a5a1b3Sopenharmony_ci/** A callback for operation state changes */
3653a5a1b3Sopenharmony_citypedef void (*pa_operation_notify_cb_t) (pa_operation *o, void *userdata);
3753a5a1b3Sopenharmony_ci
3853a5a1b3Sopenharmony_ci/** Increase the reference count by one */
3953a5a1b3Sopenharmony_cipa_operation *pa_operation_ref(pa_operation *o);
4053a5a1b3Sopenharmony_ci
4153a5a1b3Sopenharmony_ci/** Decrease the reference count by one */
4253a5a1b3Sopenharmony_civoid pa_operation_unref(pa_operation *o);
4353a5a1b3Sopenharmony_ci
4453a5a1b3Sopenharmony_ci/** Cancel the operation. Beware! This will not necessarily cancel the
4553a5a1b3Sopenharmony_ci * execution of the operation on the server side. However it will make
4653a5a1b3Sopenharmony_ci * sure that the callback associated with this operation will not be
4753a5a1b3Sopenharmony_ci * called anymore, effectively disabling the operation from the client
4853a5a1b3Sopenharmony_ci * side's view. */
4953a5a1b3Sopenharmony_civoid pa_operation_cancel(pa_operation *o);
5053a5a1b3Sopenharmony_ci
5153a5a1b3Sopenharmony_ci/** Return the current status of the operation */
5253a5a1b3Sopenharmony_cipa_operation_state_t pa_operation_get_state(const pa_operation *o);
5353a5a1b3Sopenharmony_ci
5453a5a1b3Sopenharmony_ci/** Set the callback function that is called when the operation state
5553a5a1b3Sopenharmony_ci * changes. Usually this is not necessary, since the functions that
5653a5a1b3Sopenharmony_ci * create pa_operation objects already take a callback that is called
5753a5a1b3Sopenharmony_ci * when the operation finishes. Registering a state change callback is
5853a5a1b3Sopenharmony_ci * mainly useful, if you want to get called back also if the operation
5953a5a1b3Sopenharmony_ci * gets cancelled. \since 4.0 */
6053a5a1b3Sopenharmony_civoid pa_operation_set_state_callback(pa_operation *o, pa_operation_notify_cb_t cb, void *userdata);
6153a5a1b3Sopenharmony_ci
6253a5a1b3Sopenharmony_ciPA_C_DECL_END
6353a5a1b3Sopenharmony_ci
6453a5a1b3Sopenharmony_ci#endif
65