implement proper refcounting in polyplib

split polyplib to multiple modules
add some prelimenary documentation
add doxygen support


git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@123 fefdeb5f-60dc-0310-8127-8f9354f1896f

polyp/polyplib-operation.h

@@ -0,0 +1,56 @@
+#ifndef foopolypliboperationhfoo
+#define foopolypliboperationhfoo
+
+/* $Id$ */
+
+/***
+  This file is part of polypaudio.
+ 
+  polypaudio is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published
+  by the Free Software Foundation; either version 2 of the License,
+  or (at your option) any later version.
+ 
+  polypaudio is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+ 
+  You should have received a copy of the GNU General Public License
+  along with polypaudio; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA.
+***/
+
+#include "cdecl.h"
+
+/** \file
+ * Asynchronous operations */
+
+PA_C_DECL_BEGIN
+
+enum pa_operation_state {
+    PA_OPERATION_RUNNING,      /**< The operation is still running */
+    PA_OPERATION_DONE,         /**< The operation has been completed */
+    PA_OPERATION_CANCELED,     /**< The operation has been canceled */
+};
+
+/** \struct pa_operation
+ * An asynchronous operation object */
+struct pa_operation;
+
+/** Increase the reference count by one */
+struct pa_operation *pa_operation_ref(struct pa_operation *o);
+
+/** Decrease the reference count by one */
+void pa_operation_unref(struct pa_operation *o);
+
+/** Cancel the operation. Beware! This will not necessarily cancel the execution of the operation on the server side. */
+void pa_operation_cancel(struct pa_operation *o);
+
+/** Return the current status of the operation */
+enum pa_operation_state pa_operation_get_state(struct pa_operation *o);
+
+PA_C_DECL_END
+
+#endif