X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e8c92ba7b0a64a05806dc207b31c5c84b1edb16c..985bb670b4e07d35cb1580780253ded2524a342e:/lib/logfd.c

diff --git a/lib/logfd.c b/lib/logfd.c
index 0eab833..a6f14c3 100644
--- a/lib/logfd.c
+++ b/lib/logfd.c
@@ -1,28 +1,27 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2005 Richard Kettlewell
+ * Copyright (C) 2005, 2007 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * 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
+ * the Free Software Foundation, either version 3 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.
- *
+ * 
+ * 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-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @file lib/logfd.c
+ * @brief Redirect subprocess stderr to DisOrder server's log
  */
 
-#include <config.h>
-#include "types.h"
+#include "common.h"
 
 #include <unistd.h>
-#include <string.h>
 #include <errno.h>
 
 #include "syscalls.h"
@@ -30,14 +29,9 @@
 #include "event.h"
 #include "log.h"
 
-struct logfd_state {
-  const char *tag;
-};
-
 /* called when bytes are available and at eof */
 static int logfd_readable(ev_source attribute((unused)) *ev,
 			  ev_reader *reader,
-			  int fd,
 			  void *ptr,
 			  size_t bytes,
 			  int eof,
@@ -57,23 +51,31 @@ static int logfd_readable(ev_source attribute((unused)) *ev,
     info("%s: %.*s", tag, (int)bytes, (char *)ptr);
     ev_reader_consume(reader, bytes);
   }
-  if(eof)
-    xclose(fd);
   return 0;
 }
 
 /* called when a read error occurs */
 static int logfd_error(ev_source attribute((unused)) *ev,
-		       int fd,
 		       int errno_value,
 		       void *u) {
   const char *tag = u;
   
   error(errno_value, "error reading log pipe from %s", tag);
-  xclose(fd);
   return 0;
 }
 
+/** @brief Create file descriptor for a subprocess to log to
+ * @param ev Event loop
+ * @param tag Tag for this log
+ * @return File descriptor
+ *
+ * Returns a file descriptor which a subprocess can log to.  The normal thing
+ * to do would be to dup2() this fd onto the subprocess's stderr (and to close
+ * it in the parent).
+ *
+ * Any lines written to this fd (i.e. by the subprocess) will be logged via
+ * info(), with @p tag included.
+ */
 int logfd(ev_source *ev, const char *tag) {
   int p[2];