Add documentation for para_select() and mark_fd_nonblock()
authorAndre <maan@p133.(none)>
Fri, 7 Apr 2006 13:29:52 +0000 (15:29 +0200)
committerAndre <maan@p133.(none)>
Fri, 7 Apr 2006 13:29:52 +0000 (15:29 +0200)
This patch also fixes a thinko in para_select().

fd.c
fd.h

diff --git a/fd.c b/fd.c
index c48f1fe..81ba5cf 100644 (file)
--- a/fd.c
+++ b/fd.c
@@ -1,3 +1,23 @@
+/*
+ * Copyright (C) 2006 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.
+ */
+
+/** \file fd.c helper functions for file descriptor handling */
+
 #include "para.h"
 #include "error.h"
 /**
@@ -14,6 +34,23 @@ int file_exists(const char *fn)
        return !stat(fn, &statbuf);
 }
 
+/**
+ * paraslash's wrapper for select(2)
+ *
+ * It calls select(2) (with no exceptfds) and starts over if select() was
+ * interrupted by a signal.
+ *
+ * \param n the highest-numbered descriptor in any of the two sets, plus 1
+ * \param readfds fds that should be checked for readability
+ * \param writefds fds that should be checked for writablility
+ * \param timeout upper bound on the amount of time elapsed before select()
+ *  returns
+ *
+ * \return The return value of the underlying select() call.
+ *
+ * All arguments are passed verbatim to select(2).
+ * \sa select(2) select_tut(2)
+ */
 int para_select(int n, fd_set *readfds, fd_set *writefds,
                struct timeval *timeout)
 {
@@ -21,12 +58,19 @@ int para_select(int n, fd_set *readfds, fd_set *writefds,
        do {
                ret = select(n, readfds, writefds, NULL, timeout);
                err = errno;
-       } while (ret < 0 && errno == EINTR);
+       } while (ret < 0 && err == EINTR);
        if (ret < 0)
                PARA_CRIT_LOG("select error (%s)\n", strerror(err));
        return ret;
 }
 
+/**
+ * set a file descriptor to non-blocking mode
+ *
+ * \param fd The file descriptor
+ *
+ * \returns 1 on success, -E_F_GETFL, -E_F_SETFL, on errors.
+ */
 int mark_fd_nonblock(int fd)
 {
        int flags = fcntl(fd, F_GETFL);
diff --git a/fd.h b/fd.h
index ed67215..42df3a3 100644 (file)
--- a/fd.h
+++ b/fd.h
@@ -16,7 +16,7 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
-/** \file fd.h file handling functions */
+/** \file fd.h exported symbols from fd.c */
 
 int file_exists(const char *);
 int para_select(int n, fd_set *readfds, fd_set *writefds,