From: Paul Querna <pquerna@apache.org>
Date: Thu, 8 Jan 2009 18:17:49 +0000 (+0000)
Subject: Add basic docs on mod_proxy_fdpass.
X-Git-Tag: 2.3.2~208
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e12c33d614a4a14191baf9642d73def700eb6559;p=thirdparty%2Fapache%2Fhttpd.git

Add basic docs on mod_proxy_fdpass.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@732775 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/mod/allmodules.xml b/docs/manual/mod/allmodules.xml
index 180a010539b..1c773368582 100644
--- a/docs/manual/mod/allmodules.xml
+++ b/docs/manual/mod/allmodules.xml
@@ -72,6 +72,7 @@
   <modulefile>mod_proxy_balancer.xml</modulefile>
   <modulefile>mod_proxy_connect.xml</modulefile>
   <modulefile>mod_proxy_fcgi.xml</modulefile>
+  <modulefile>mod_proxy_fdpass.xml</modulefile>
   <modulefile>mod_proxy_ftp.xml</modulefile>
   <modulefile>mod_proxy_http.xml</modulefile>
   <modulefile>mod_proxy_scgi.xml</modulefile>
diff --git a/docs/manual/mod/mod_proxy_fdpass.xml b/docs/manual/mod/mod_proxy_fdpass.xml
new file mode 100644
index 00000000000..a0318decd51
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_fdpass.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
+<!-- $LastChangedRevision$ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_proxy_fdpass.xml.meta">
+
+<name>mod_proxy_fdpass</name>
+<description>FastCGI support module for
+<module>mod_proxy</module></description>
+<status>Extension</status>
+<sourcefile>mod_proxy_fdpass.c</sourcefile>
+<identifier>proxy_fdpass_module</identifier>
+<compatibility>Available in version 2.3 and later</compatibility>
+
+<summary>
+    <p>This module <em>requires</em> the service of <module
+    >mod_proxy</module>. It provides support for the passing the socket of the
+    client to another process.
+    <p><code>mod_proxy_fdpass</code> uses the ability of AF_UNIX domain 
+    sockets to <a href="http://www.freebsd.org/cgi/man.cgi?query=recv">pass an 
+    open file descriptor</a> to allow another process to finish handling a request.
+    </p>
+
+    <p>The module has a <code>proxy_fdpass_flusher</code> provider interface, 
+    which allows another module to optionally send the response headers, or even
+    the start of the response body.  The default flush provider disables keep-alive,
+    and sends the response headers, letting the external process just send a
+    response body.</p>
+
+    <o>At this time the only data passed to the external process is the client 
+    socket. To recieve a client socket, call recvfrom with the an allocated 
+    <a href="http://www.kernel.org/doc/man-pages/online/pages/man3/cmsg.3.html"
+    ><code>struct cmsghdr</code></a>. Future versions of this module may include
+    more data after the client socket, but this is not implemented at this time.
+    </p>
+</summary>
+
+<seealso><module>mod_proxy</module></seealso>
+</modulesynopsis>
diff --git a/docs/manual/mod/mod_proxy_fdpass.xml.meta b/docs/manual/mod/mod_proxy_fdpass.xml.meta
new file mode 100644
index 00000000000..404e8d0f19b
--- /dev/null
+++ b/docs/manual/mod/mod_proxy_fdpass.xml.meta
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile>
+  <basename>mod_proxy_fdpass</basename>
+  <path>/mod/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>