summaryrefslogtreecommitdiffstats
path: root/src/pulsecore/client.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/pulsecore/client.h')
-rw-r--r--src/pulsecore/client.h57
1 files changed, 57 insertions, 0 deletions
diff --git a/src/pulsecore/client.h b/src/pulsecore/client.h
new file mode 100644
index 00000000..1e72baf7
--- /dev/null
+++ b/src/pulsecore/client.h
@@ -0,0 +1,57 @@
+#ifndef fooclienthfoo
+#define fooclienthfoo
+
+/* $Id$ */
+
+/***
+ This file is part of PulseAudio.
+
+ PulseAudio is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as published
+ by the Free Software Foundation; either version 2 of the License,
+ or (at your option) any later version.
+
+ PulseAudio 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 Lesser General Public License
+ along with PulseAudio; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+ USA.
+***/
+
+#include <pulsecore/core.h>
+#include <pulsecore/module.h>
+
+/* Every connection to the server should have a pa_client
+ * attached. That way the user may generate a listing of all connected
+ * clients easily and kill them if he wants.*/
+
+typedef struct pa_client pa_client;
+
+struct pa_client {
+ uint32_t index;
+
+ pa_module *owner;
+ char *name, *driver;
+ pa_core *core;
+
+ void (*kill)(pa_client *c);
+ void *userdata;
+};
+
+pa_client *pa_client_new(pa_core *c, const char *driver, const char *name);
+
+/* This function should be called only by the code that created the client */
+void pa_client_free(pa_client *c);
+
+/* Code that didn't create the client should call this function to
+ * request destruction of the client */
+void pa_client_kill(pa_client *c);
+
+/* Rename the client */
+void pa_client_set_name(pa_client *c, const char *name);
+
+#endif