afs.c: Fix documentation of stdin_command().
[paraslash.git] / stat.c
diff --git a/stat.c b/stat.c
index 532f9cdfc5449add435bcfb4ba71a91924991c9b..ce6adeda2019454acfdf4ca5759e4a29cc4c2e64 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -1,25 +1,18 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program 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.
- *
- *     This program 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 this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /**
  *  \file stat.c functions used for sending/receiving the status of para_server
  *  and para_audiod
  */
+
+
+#include <sys/types.h>
+#include <dirent.h>
+
 #include "para.h"
 #include "close_on_fork.h"
 #include "list.h"
 #define MAX_STAT_CLIENTS 50
 
 /**
- * The structure associated with a connected client that sent the 'stat' command
-*
+ * describes a status client of para_audiod
+ *
+ * There's one such structure per audiod client that sent the 'stat' command.
  *
  * A status client is identified by its file descriptor.  para_audiod
  * keeps a list of connected status clients.
  */
 struct stat_client {
-/**
- *
- *
- * the stat client's file descriptor
- */
-int fd;
-long unsigned item_mask;
-/**
- *
- * its entry in the list of stat clients
-*/
-struct list_head node;
+       /** the stat client's file descriptor */
+       int fd;
+       /** bitmask of those status items the client is interested in */
+       long unsigned item_mask;
+       /** its entry in the list of stat clients */
+       struct list_head node;
 };
 
 static struct list_head client_list;
@@ -95,7 +83,6 @@ const char *status_item_list[NUM_STAT_ITEMS] = {
        [SI_AUDIOD_UPTIME] = "audiod_uptime",
        [SI_SELECTOR] = "dbtool"
 };
-#define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
 
 static void dump_stat_client_list(void)
 {
@@ -109,8 +96,14 @@ static void dump_stat_client_list(void)
 /**
  * add a status client to the list
  *
+ * \param fd the file descriptor of the client
+ * \param mask bitfield of status items for this client
+ *
+ * Only those status items having the bit set in \a mask will be
+ * sent to the client.
+ *
  * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
- * the number of connected clients exceeds #MAX_STAT_CLIENTS
+ * the number of connected clients exceeds #MAX_STAT_CLIENTS.
  */
 int stat_client_add(int fd, long unsigned mask)
 {
@@ -129,8 +122,7 @@ int stat_client_add(int fd, long unsigned mask)
        new_client = para_malloc(sizeof(struct stat_client));
        new_client->fd = fd;
        new_client->item_mask = mask;
-       add_close_on_fork_list(fd);
-       list_add(&new_client->node, &client_list);
+       para_list_add(&new_client->node, &client_list);
        dump_stat_client_list();
        num_clients++;
        return 1;
@@ -144,15 +136,14 @@ int stat_client_add(int fd, long unsigned mask)
  * On write errors, remove the status client from the client list and close its
  * file descriptor.
  */
-void stat_client_write(char *msg, int itemnum)
+void stat_client_write(const char *msg, int itemnum)
 {
        struct stat_client *sc, *tmp;
-       ssize_t len;
+       size_t len = strlen(msg);
        struct timeval tv = {0 , 0};
 
-       if (!initialized)
+       if (!initialized || !len)
                return;
-       len = strlen(msg);
        list_for_each_entry_safe(sc, tmp, &client_list, node) {
                int fd = sc->fd, ret;
                fd_set wfds;
@@ -171,7 +162,6 @@ void stat_client_write(char *msg, int itemnum)
                }
                /* write error or fd not ready for writing */
                close(fd);
-               del_close_on_fork_list(fd);
                num_clients--;
                PARA_INFO_LOG("deleting client on fd %d\n", fd);
                list_del(&sc->node);
@@ -181,24 +171,6 @@ void stat_client_write(char *msg, int itemnum)
        PARA_DEBUG_LOG("%d client(s)\n", num_clients);
 }
 
-/**
- * send empty status list
- *
- * Send to  each connected client the full status item list
- * with empty values.
- */
-void dump_empty_status(void)
-{
-       int i;
-
-       if (!initialized)
-               return;
-       FOR_EACH_STAT_ITEM(i) {
-               char *tmp = make_message("%s:\n", status_item_list[i]);
-               stat_client_write(tmp, i);
-               free(tmp);
-       }
-}
 
 /**
  * check if string is a known status item.
@@ -249,55 +221,3 @@ int stat_line_valid(const char *line)
        return -E_UNKNOWN_STAT_ITEM;
 }
 
-/**
- * call a custom function for each complete line
- *
- * \param buf the buffer containing data seperated by newlines
- * \param n the number of bytes in \a buf
- * \param line_handler the custom function
- *
- * If \a line_handler is \p NULL, return number of complete lines in buf.
- * Otherwise, call \a line_handler for each complete line.  The rest of the
- * buffer (last chunk containing incomplete line is moved to the beginning of
- * the buffer.
- *
- * \return If line_handler is not NULL, this function returns the number
- * of bytes not handled to \a line_handler.
- */
-unsigned for_each_line(char *buf, int n, void (*line_handler)(char *))
-{
-       char *start = buf, *end;
-       int i, num_lines = 0;
-
-       PARA_INFO_LOG("buf: %s", buf);
-       while (start < buf + n) {
-               char *next_null;
-               char *next_cr;
-
-               next_cr = memchr(start, '\n', buf + n - start);
-               next_null = memchr(start, '\0', buf + n - start);
-               if (!next_cr && !next_null)
-                       break;
-               if (next_cr && next_null) {
-                       end = next_cr < next_null? next_cr : next_null;
-               } else if (next_null) {
-                       end = next_null;
-               } else
-                       end = next_cr;
-               num_lines++;
-               if (line_handler) {
-                       *end = '\0';
-                       PARA_INFO_LOG("calling line handler: %s\n", start);
-                       line_handler(start);
-                       start = ++end;
-               } else
-                       start = ++end;
-       }
-       if (!line_handler)
-               return num_lines;
-       i = buf + n - start;
-       if (i && i != n)
-               memmove(buf, start, i);
-       return i;
-}
-