granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_fdpass.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_proxy_fdpass.xml.meta">
  24
  25 <name>mod_proxy_fdpass</name>
  26 <description>fdpass external process support module for
  27 <module>mod_proxy</module></description>
  28 <status>Extension</status>
  29 <sourcefile>mod_proxy_fdpass.c</sourcefile>
  30 <identifier>proxy_fdpass_module</identifier>
  31 <compatibility>Available for unix in version 2.3 and later</compatibility>
  32
  33 <summary>
  34     <p>This module <em>requires</em> the service of <module
  35     >mod_proxy</module>. It provides support for the passing the socket of the
  36     client to another process.</p>
  37
  38     <p><code>mod_proxy_fdpass</code> uses the ability of AF_UNIX domain
  39     sockets to <a href="http://www.freebsd.org/cgi/man.cgi?query=recv">pass an
  40     open file descriptor</a> to allow another process to finish handling a request.
  41     </p>
  42
  43     <p>The module has a <code>proxy_fdpass_flusher</code> provider interface,
  44     which allows another module to optionally send the response headers, or even
  45     the start of the response body.  The default flush provider disables keep-alive,
  46     and sends the response headers, letting the external process just send a
  47     response body.</p>
  48
  49     <p>At this time the only data passed to the external process is the client
  50     socket. To receive a client socket, call recvfrom with an allocated
  51     <a href="http://www.kernel.org/doc/man-pages/online/pages/man3/cmsg.3.html"
  52     ><code>struct cmsghdr</code></a>. Future versions of this module may include
  53     more data after the client socket, but this is not implemented at this time.
  54     </p>
  55 </summary>
  56
  57 <seealso><module>mod_proxy</module></seealso>
  58 </modulesynopsis>