src/pulse/operation.h

   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 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, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 #include <pulse/cdecl.h>
  26 #include <pulse/def.h>
  27 #include <pulse/version.h>
  28
  29 /** \file
  30  * Asynchronous operations */
  31
  32 PA_C_DECL_BEGIN
  33
  34 /** An asynchronous operation object */
  35 typedef struct pa_operation pa_operation;
  36
  37 /** Increase the reference count by one */
  38 pa_operation *pa_operation_ref(pa_operation *o);
  39
  40 /** Decrease the reference count by one */
  41 void pa_operation_unref(pa_operation *o);
  42
  43 /** Cancel the operation. Beware! This will not necessarily cancel the execution of the operation on the server side. */
  44 void pa_operation_cancel(pa_operation *o);
  45
  46 /** Return the current status of the operation */
  47 pa_operation_state_t pa_operation_get_state(pa_operation *o);
  48
  49 PA_C_DECL_END
  50
  51 #endif