lca2011: add option parsing using ccan/opt.

[ccan-lca-2011.git] / ccan / oserver / oserver.h

diff --git a/ccan/oserver/oserver.h b/ccan/oserver/oserver.h
index fa214b4c951db53f78a8d0ecba418e03a3b02856..f71f3e2881182b7d4d9848cc8ca2f0d7a05dbd19 100644 (file)
--- a/ccan/oserver/oserver.h
+++ b/ccan/oserver/oserver.h
@@ -1,9 +1,43 @@
 #ifndef CCAN_OSERVER_H
 #define CCAN_OSERVER_H
-#include <ccan/compiler/compiler.h>
+#include <stdbool.h>
 
-void NORETURN oserver_serve(int fd);
-int oserver_setup(void);
+/**
+ * oserver_setup - get a listening filedescriptor for an oserver
+ * @port: port to use (usually OSERVER_PORT)
+ * Opens a socket and binds it to @port, then sets it up to listen
+ * for connections and returns it.
+ *
+ * Example:
+ *     int serverfd;
+ *
+ *     serverfd = oserver_setup(OSERVER_PORT);
+ *     if (serverfd < 0)
+ *             err(1, "Failed to set up server");
+ */
+int oserver_setup(unsigned short port);
+
+/**
+ * oserver_serve - serve an oserver client via a file descriptor
+ * @fd: the file descriptor (usually a connected socket)
+ *
+ * This returns false (with errno set) on failure.
+ *
+ * Example:
+ *      #include <sys/types.h>
+ *      #include <sys/socket.h>
+ *     ...
+ *             int clientfd;
+ *     ...
+ *             clientfd = accept(serverfd, NULL, NULL);
+ *             if (clientfd < 0)
+ *                     err(1, "Accepting connection from client");
+ *             if (fork() == 0)
+ *                     exit(oserver_serve(clientfd) ? 0 : 1);
+ *             else
+ *                     close(clientfd);
+ */
+bool oserver_serve(int fd);
 
 #define OSERVER_PORT 2727
 #endif /* CCAN_OSERVER_H */