src/pulsecore/client.h

   1 #ifndef fooclienthfoo
   2 #define fooclienthfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of PulseAudio.
   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 <pulsecore/core.h>
  26 #include <pulsecore/module.h>
  27
  28 /* Every connection to the server should have a pa_client
  29  * attached. That way the user may generate a listing of all connected
  30  * clients easily and kill them if he wants.*/
  31
  32 typedef struct pa_client pa_client;
  33
  34 struct pa_client {
  35     uint32_t index;
  36
  37     pa_module *owner;
  38     char *name, *driver;
  39     pa_core *core;
  40
  41     void (*kill)(pa_client *c);
  42     void *userdata;
  43 };
  44
  45 pa_client *pa_client_new(pa_core *c, const char *driver, const char *name);
  46
  47 /* This function should be called only by the code that created the client */
  48 void pa_client_free(pa_client *c);
  49
  50 /* Code that didn't create the client should call this function to
  51  * request destruction of the client */
  52 void pa_client_kill(pa_client *c);
  53
  54 /* Rename the client */
  55 void pa_client_set_name(pa_client *c, const char *name);
  56
  57 #endif