code.delx.au - pulseaudio/blob - polyp/polyplib-operation.h

   1 #ifndef foopolypliboperationhfoo
   2 #define foopolypliboperationhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of polypaudio.
   8
   9   polypaudio 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   polypaudio 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 polypaudio; 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 "cdecl.h"
  26 #include "polyplib-def.h"
  27
  28 /** \file
  29  * Asynchronous operations */
  30
  31 PA_C_DECL_BEGIN
  32
  33 /** \struct pa_operation
  34  * An asynchronous operation object */
  35 struct pa_operation;
  36
  37 /** Increase the reference count by one */
  38 struct pa_operation *pa_operation_ref(struct pa_operation *o);
  39
  40 /** Decrease the reference count by one */
  41 void pa_operation_unref(struct 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(struct pa_operation *o);
  45
  46 /** Return the current status of the operation */
  47 enum pa_operation_state pa_operation_get_state(struct pa_operation *o);
  48
  49 PA_C_DECL_END
  50
  51 #endif