src/client.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef MPD_CLIENT_H
  21 #define MPD_CLIENT_H
  22
  23 #include <glib.h>
  24 #include <stdbool.h>
  25 #include <stddef.h>
  26 #include <stdarg.h>
  27
  28 struct client;
  29 struct sockaddr;
  30
  31 void client_manager_init(void);
  32 void client_manager_deinit(void);
  33
  34 void client_new(int fd, const struct sockaddr *sa, size_t sa_length, int uid);
  35
  36 bool client_is_expired(const struct client *client);
  37
  38 /**
  39  * returns the uid of the client process, or a negative value if the
  40  * uid is unknown
  41  */
  42 int client_get_uid(const struct client *client);
  43
  44 unsigned client_get_permission(const struct client *client);
  45
  46 void client_set_permission(struct client *client, unsigned permission);
  47
  48 /**
  49  * Write a C string to the client.
  50  */
  51 void client_puts(struct client *client, const char *s);
  52
  53 /**
  54  * Write a printf-like formatted string to the client.
  55  */
  56 void client_vprintf(struct client *client, const char *fmt, va_list args);
  57
  58 /**
  59  * Write a printf-like formatted string to the client.
  60  */
  61 G_GNUC_PRINTF(2, 3) void client_printf(struct client *client, const char *fmt, ...);
  62
  63 /**
  64  * Adds the specified idle flags to all clients and immediately sends
  65  * notifications to all waiting clients.
  66  */
  67 void client_manager_idle_add(unsigned flags);
  68
  69 /**
  70  * Checks whether the client has pending idle flags.  If yes, they are
  71  * sent immediately and "true" is returned".  If no, it puts the
  72  * client into waiting mode and returns false.
  73  */
  74 bool client_idle_wait(struct client *client, unsigned flags);
  75
  76 #endif