www/hunchentoot-doc.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
   2 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></meta><title>Hunchentoot - The Common Lisp web server formerly known as TBNL</title><meta name="description" content="
   3     A full-featured web server written in Common Lisp offering things
   4     like HTTP/1.1 chunking, persistent connections, and SSL.  Includes
   5     a framework for building dynamic websites interactively.
   6   "></meta><style type="text/css">
   7   body { background-color: #ffffff }
   8   pre { padding:5px; background-color:#e0e0e0 }
   9   pre.none { padding:5px; background-color:#ffffff }
  10   h3, h4, h5 { text-decoration: underline; }
  11   .entry-type { padding-left: 1em; font-size: 60%; font-style: italic }
  12   a { text-decoration: none; padding: 1px 2px 1px 2px; }
  13   a:visited { text-decoration: none; padding: 1px 2px 1px 2px; }
  14   a:hover { text-decoration: none; padding: 1px 1px 1px 1px; border: 1px solid #000000; }
  15   a:focus { text-decoration: none; padding: 1px 2px 1px 2px; border: none; }
  16   a.none { text-decoration: none; padding: 0; }
  17   a.none:visited { text-decoration: none; padding: 0; }
  18   a.none:hover { text-decoration: none; border: none; padding: 0; }
  19   a.none:focus { text-decoration: none; border: none; padding: 0; }
  20   a.noborder { text-decoration: none; padding: 0; }
  21   a.noborder:visited { text-decoration: none; padding: 0; }
  22   a.noborder:hover { text-decoration: none; border: none; padding: 0; }
  23   a.noborder:focus { text-decoration: none; border: none; padding: 0; }
  24         </style></head><body>
  25
  26
  27
  28   <h2>
  29     <a href="http://www.htg1.de/hunchentoot/hunchentoot.html" title="Click here for the Hunchentoot logo" class="noborder">
  30       <img align="top" width="93" height="45" border="0" src="hunchentoot.gif"></img>
  31     </a>
  32     Hunchentoot - The Common Lisp web server formerly known as TBNL
  33   </h2>
  34
  35   <blockquote>
  36     <h3 xmlns=""><a class="none" name="abstract">Abstract</a></h3>
  37       <p>
  38         Hunchentoot is a web server written in Common Lisp and at the
  39         same time a toolkit for building dynamic websites.  As a
  40         stand-alone web server, Hunchentoot is capable of HTTP/1.1
  41         chunking (both directions), persistent connections
  42         (keep-alive), and SSL.
  43       </p>
  44       <p>
  45         Hunchentoot provides facilities like automatic session
  46         handling (with and without cookies), logging, customizable
  47         error handling, and easy access to GET and POST parameters
  48         sent by the client. It does <em>not</em> include functionality
  49         to programmatically generate HTML output. For this task you
  50         can use any library you like, e.g. (shameless self-plug)
  51         <a href="http://weitz.de/cl-who/">CL-WHO</a> or
  52         <a href="http://weitz.de/html-template/">HTML-TEMPLATE</a>.
  53       </p>
  54       <p>
  55         Hunchentoot talks with its front-end or with the client over
  56         TCP/IP sockets and optionally uses multiprocessing to handle
  57         several requests at the same time.  Therefore, it cannot be
  58         implemented completely in <a href="http://www.lispworks.com/documentation/HyperSpec/Front/index.htm">portable
  59         Common Lisp</a>.  It currently works with <a href="http://www.lispworks.com/">LispWorks</a> and all Lisps
  60         which are supported by the compatibility layers <a href="http://common-lisp.net/project/usocket/">usocket</a> and
  61         <a href="http://common-lisp.net/project/bordeaux-threads/">Bordeaux
  62         Threads</a>.
  63       </p>
  64       <p>
  65         Hunchentoot comes with a
  66         <a href="http://www.opensource.org/licenses/bsd-license.php">BSD-style
  67         license</a> so you can basically do with it whatever you want.
  68       </p>
  69       <p>
  70         Hunchentoot is (or was) for example used by
  71         <a href="http://quickhoney.com/">QuickHoney</a>,
  72         <a href="http://www.city-farming.de/">City Farming</a>,
  73         <a href="http://heikestephan.de/">Heike Stephan</a>.
  74       </p>
  75       <p>
  76         <font color="red">Download shortcut:</font>
  77         <a href="http://weitz.de/files/hunchentoot.tar.gz">http://weitz.de/files/hunchentoot.tar.gz</a>.
  78       </p>
  79
  80   </blockquote>
  81
  82   <h3 xmlns=""><a class="none" name="contents">Contents</a></h3>
  83   <ol xmlns="">
  84 <li><a href="#abstract">Abstract</a></li>
  85 <li><a href="#contents">Contents</a></li>
  86 <li>
  87 <a href="#install">Download and installation</a><ol>
  88 <li><a href="#port80">Running Hunchentoot on port 80</a></li>
  89 <li><a href="#proxy">Hunchentoot behind a proxy</a></li>
  90 </ol>
  91 </li>
  92 <li><a href="#support">Support</a></li>
  93 <li><a href="#teen-age">Your own webserver (the easy teen-age New York version)</a></li>
  94 <li><a href="#extras">Third party documentation and add-ons</a></li>
  95 <li>
  96 <a href="#reference">Function and variable reference</a><ol>
  97 <li><a href="#acceptors">Acceptors</a></li>
  98 <li><a href="#acceptor-behaviour">Customizing acceptor behaviour</a></li>
  99 <li><a href="#subclassing-acceptors">An example of how to subclass ACCEPTOR</a></li>
 100 <li><a href="#taskmasters">Taskmasters</a></li>
 101 <li><a href="#request-dispatch">Request dispatch and handling</a></li>
 102 <li><a href="#easy-handlers">Using the easy-handler framework</a></li>
 103 <li><a href="#requests">Request objects</a></li>
 104 <li><a href="#replies">Reply objects</a></li>
 105 <li><a href="#sessions">Sessions</a></li>
 106 <li><a href="#session-behaviour">Customizing session behaviour</a></li>
 107 <li><a href="#cookies">Cookies</a></li>
 108 <li><a href="#logging">Logging</a></li>
 109 <li><a href="#conditions">Conditions and error handling</a></li>
 110 <li><a href="#misc">Miscellaneous</a></li>
 111 </ol>
 112 </li>
 113 <li><a href="#testing">Testing</a></li>
 114 <li><a href="#debugging">Debugging</a></li>
 115 <li><a href="#history">History</a></li>
 116 <li><a href="#index">Symbol index</a></li>
 117 <li><a href="#ack">Acknowledgements</a></li>
 118 </ol>
 119
 120   <h3 xmlns=""><a class="none" name="install">Download and installation</a></h3>
 121     Hunchentoot depends on a couple of other Lisp libraries which you'll need
 122     to install first:
 123     <ul>
 124       <li>Pierre R. Mai's <a href="http://www.cliki.net/md5">MD5</a>,</li>
 125       <li>Kevin Rosenberg's <a href="http://www.cliki.net/cl-base64">CL-BASE64</a>,</li>
 126       <li>Janis Dzerins' <a href="http://common-lisp.net/project/rfc2388/">RFC2388</a>,</li>
 127       <li>Peter Seibel's <a href="http://weitz.de/cl-fad/">CL-FAD</a>,</li>
 128       <li>Gary King's <a href="http://common-lisp.net/project/trivial-backtrace/">trivial-backtrace</a>,</li>
 129       <li>Erik Huelsmann's <a href="http://common-lisp.net/project/usocket">usocket</a> (unless you're using LispWorks),</li>
 130       <li>Greg Pfeil's <a href="http://common-lisp.net/project/bordeaux-threads/">Bordeaux Threads</a> (unless you're using LispWorks),
 131       </li>
 132       <li>
 133         David Lichteblau's <a href="http://common-lisp.net/project/cl-plus-ssl/">CL+SSL</a>
 134         (unless you're using LispWorks),
 135       </li>
 136       <li>
 137         and my own <a href="http://weitz.de/flexi-streams/">FLEXI-STREAMS</a> (0.12.0 or higher),
 138         <a href="http://weitz.de/chunga/">Chunga</a> (1.0.0 or
 139         higher), and <a href="http://weitz.de/cl-ppcre/">
 140         CL-PPCRE</a> (plus
 141         <a href="http://weitz.de/cl-who/">CL-WHO</a> for the <a href="#teen-age">example code</a>
 142         and <a href="http://weitz.de/drakma/">Drakma</a> for the <a href="#testing">tests</a>).
 143       </li>
 144     </ul>
 145
 146     Make sure to use the <em>newest</em> versions of all of these
 147     libraries (which might themselves depend on other libraries) - try
 148     the repository versions if you're in doubt.  Note: You can compile
 149     Hunchentoot without SSL support - and thus without the need to
 150     have CL+SSL - if you add <code>:HUNCHENTOOT-NO-SSL</code> to
 151     <a href="http://www.lispworks.com/documentation/HyperSpec/Body/v_featur.htm">
 152       <code>*FEATURES*</code></a> <em>before</em> you compile it.
 153     <p>
 154       Hunchentoot will only work with Lisps where
 155       the <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_c.htm#character_code">character
 156       codes</a> of
 157       all <a href="http://en.wikipedia.org/wiki/ISO/IEC_8859-1">Latin-1</a>
 158       characters coincide with their
 159       Unicode <a href="http://en.wikipedia.org/wiki/Code_point">code
 160       points</a> (which is the case for all current implementations I
 161       know).
 162     </p>
 163     <p>
 164       Hunchentoot itself together with this documentation can be
 165       downloaded from
 166       <a href="http://weitz.de/files/hunchentoot.tar.gz">http://weitz.de/files/hunchentoot.tar.gz</a>.
 167       The current version is 1.2.37.
 168     </p>
 169     <p>
 170       The preferred method to compile and load Hunchentoot is via <a href="http://www.cliki.net/asdf">ASDF</a>.  If you want to avoid
 171       downloading and installing all the dependencies manually, give
 172       Zach Beane's excellent <a href="http://www.quicklisp.org/">Quicklisp</a> system a try.
 173     </p>
 174     <p>
 175       Hunchentoot and its dependencies can also be installed with <a href="http://common-lisp.net/project/clbuild/">clbuild</a>.
 176       There's also a port for <a href="http://www.gentoo.org/proj/en/lisp/common-lisp/index.xml">Gentoo
 177       Linux</a> thanks to Matthew Kennedy.
 178     </p>
 179     <p>
 180       The current development version of Hunchentoot can be found
 181       at <a href="https://github.com/edicl/hunchentoot">https://github.com/edicl/hunchentoot</a>.
 182       If you want to send patches, please fork the github repository and send pull requests.
 183     </p>
 184
 185     <h4 xmlns=""><a name="port80">Running Hunchentoot on port 80</a></h4>
 186
 187       Hunchentoot does not come with code to help with running it on a
 188       privileged port (i.e. port 80 or 443) on Unix-like operating
 189       systems.  Modern Unix-like systems have specific, non-portable
 190       ways to allow non-root users to listen to privileged ports, so
 191       including such functionality in Hunchentoot was considered
 192       unnecessary.  Please refer to online resources for help.  At the
 193       time of this writing, the YAWS documentation has a <a href="http://yaws.hyber.org/privbind.yaws">comprehensive
 194       writeup</a> on the topic.
 195
 196
 197     <h4 xmlns=""><a name="proxy">Hunchentoot behind a proxy</a></h4>
 198
 199       If you're feeling unsecure about exposing Hunchentoot to the wild,
 200       wild Internet or if your Lisp web application is part of a larger
 201       website, you can hide it behind a
 202       <a href="http://en.wikipedia.org/wiki/Proxy_server">proxy server</a>.
 203       One approach that I have used several times is to employ Apache's
 204       <a href="http://httpd.apache.org/docs/current/mod/mod_proxy.html">mod_proxy</a>
 205       module with a configuration that looks like this:
 206
 207 <pre><a href="http://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypass" class="noborder">ProxyPass</a> /hunchentoot http://127.0.0.1:3000/hunchentoot
 208 <a href="http://httpd.apache.org/docs/current/mod/mod_proxy.html#proxypassreverse" class="noborder">ProxyPassReverse</a> /hunchentoot http://127.0.0.1:3000/hunchentoot</pre>
 209
 210       This will tunnel all requests where the URI path begins with
 211       <code>"/hunchentoot"</code> to a (Hunchentoot) server listening on
 212       port 3000 on the same machine.
 213
 214       <p>
 215         Of course, there are
 216         <a href="http://www.red-bean.com/pipermail/lispweb/2006-October/001342.html">several
 217           other</a> (more lightweight) web proxies that you could use
 218         instead of Apache.
 219       </p>
 220
 221
 222
 223   <h3 xmlns=""><a class="none" name="support">Support</a></h3>
 224     <p>
 225       The development version of Hunchentoot can be found <a href="https://github.com/edicl/hunchentoot" target="_new">on
 226       github</a>.  Please use the github issue tracking system to
 227       submit bug reports.  Patches are welcome, please use <a href="https://github.com/edicl/hunchentoot/pulls">GitHub pull
 228       requests</a>.  If you want to make a change, please <a href="http://weitz.de/patches.html" target="_new">read this
 229       first</a>.
 230     </p>
 231
 232
 233   <h3 xmlns=""><a class="none" name="teen-age">Your own webserver (the easy teen-age New York version)</a></h3>
 234     Starting your own web server is pretty easy.  Do something like this:
 235 <pre>(hunchentoot:<a class="noborder" href="#teen-age">start</a> (make-instance 'hunchentoot:<a class="noborder" href="#acceptor">easy-acceptor</a> :port 4242))</pre>
 236     That's it.  Now you should be able to enter the address
 237     "<a href="http://127.0.0.1:4242/"><code>http://127.0.0.1:4242/</code></a>" in
 238     your browser and see something, albeit nothing very interesting
 239     for now.
 240
 241     <p>
 242       By default, Hunchentoot serves the files from the
 243       <code><i>www/</i></code> directory in its source tree.  In the
 244       distribution, that directory contains a HTML version of the
 245       documentation as well as the error templates.  The location of
 246       the document root directory can be specified when creating a new
 247       <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> instance by the way of the
 248       <code xmlns=""><a href="#acceptor-document-root">ACCEPTOR-DOCUMENT-ROOT</a></code>.  Likewise, the
 249       location of the error template directory can be specified by the
 250       <code xmlns=""><a href="#acceptor-error-template-directory">ACCEPTOR-ERROR-TEMPLATE-DIRECTORY</a></code>.  Both
 251       <code xmlns=""><a href="#acceptor-document-root">ACCEPTOR-DOCUMENT-ROOT</a></code> and
 252       <code xmlns=""><a href="#acceptor-error-template-directory">ACCEPTOR-ERROR-TEMPLATE-DIRECTORY</a></code> can be
 253       specified using a logical pathname, which will be translated
 254       once when the <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> is instantiated.
 255     </p>
 256
 257     <p>
 258       The <code xmlns=""><a href="#easy-acceptor">EASY-ACCEPTOR</a></code> class implements a
 259       framework for developing web applications.  Handlers are defined
 260       using the <code xmlns=""><a href="#define-easy-handler">DEFINE-EASY-HANDLER</a></code> macro.
 261       Request dispatching is performed according to the list of
 262       dispatch functions in <code xmlns=""><a href="#*dispatch-table*">*DISPATCH-TABLE*</a></code>.
 263       Each of the functions on that list is called to determine
 264       whether it wants to handle the request, provided as single
 265       argument.  If a dispatcher function wants to handle the request,
 266       it returns another function to actually create the desired page.
 267     </p>
 268
 269     <p>
 270       <code xmlns=""><a href="#define-easy-handler">DEFINE-EASY-HANDLER</a></code> is accompanied by a set
 271       of dispatcher creation functions that can be used to create
 272       dispatchers for standard tasks.  These are documented in the <a class="noborder" href="#easy-handlers">subchapter on easy
 273       handlers</a>
 274     </p>
 275
 276     <p>
 277       Now be a bit more adventurous, try this
 278 <pre>(hunchentoot:<a class="noborder" href="#define-easy-handler">define-easy-handler</a> (say-yo :uri "/yo") (name)
 279   (setf (hunchentoot:<a class="noborder" href="#content-type*">content-type*</a>) "text/plain")
 280   (format nil "Hey~@[ ~A~]!" name))</pre>
 281       and see what happens at "<a href="http://127.0.0.1:4242/yo"><code>http://127.0.0.1:4242/yo</code></a>" or
 282       "<a href="http://127.0.0.1:4242/yo?name=Dude"><code>http://127.0.0.1:4242/yo?name=Dude</code></a>" .
 283     </p>
 284
 285     <p>
 286     Hunchentoot comes with a little example website which you can use
 287     to see if it works and which should also demonstrate a couple of
 288     the things you can do with Hunchentoot.  To start the example
 289     website, enter the following code into your listener:
 290
 291 <pre>(<a class="noborder" href="http://common-lisp.net/~mmommer/asdf-howto.shtml#sec11">asdf:oos</a> 'asdf:load-op :hunchentoot-test)</pre>
 292
 293     Now go to "<a href="http://127.0.0.1:4242/hunchentoot/test"><code>http://127.0.0.1:4242/hunchentoot/test</code></a>" and play a bit.
 294     </p>
 295
 296
 297   <h3 xmlns=""><a class="none" name="extras">Third party documentation and add-ons</a></h3>
 298     <p>
 299       Adam Petersen has written a book called <a href="http://www.adampetersen.se/articles/lispweb.htm">"Lisp for
 300       the Web"</a> which explains how Hunchentoot and some other
 301       libraries can be used to build web sites.
 302     </p>
 303     <p>
 304       Here is some software which extends Hunchentoot or is based on it:
 305     </p>
 306     <ul>
 307       <li>
 308         <a href="http://weblocks-framework.info/">Weblocks</a> by
 309         Slava Akhmechet is a "continuations-based web framework" which
 310         is based on Hunchentoot.
 311       </li>
 312       <li>
 313         <a href="https://github.com/slyrus/hunchentoot-cgi">hunchentoot-cgi</a>
 314         (by Cyrus Harmon) provides
 315         <a href="http://en.wikipedia.org/wiki/Common_Gateway_Interface">CGI</a>
 316         handlers for Hunchentoot.
 317       </li>
 318       <li>
 319         <a href="http://weitz.de/cl-webdav/">CL-WEBDAV</a> is a <a href="http://webdav.org/">WebDAV</a>
 320         server based on Hunchentoot.
 321       </li>
 322       <li>
 323         <a href="http://restas.lisper.ru/">RESTAS</a> is a web
 324         framework based on Hunchentoot.
 325       </li>
 326     </ul>
 327
 328
 329   <h3 xmlns=""><a class="none" name="reference">Function and variable reference</a></h3>
 330
 331     <h4 xmlns=""><a name="acceptors">Acceptors</a></h4>
 332
 333       If you want Hunchentoot to actually do something, you have to create and
 334       <a href="#teen-age">start</a> an <a href="#acceptor">acceptor</a>.
 335       You can also run several acceptors in one image, each one
 336       listening on a different different port.
 337
 338       <p xmlns=""><a class="none" name="acceptor"></a>
 339       [Standard class]
 340       <br><b>acceptor</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 341           To create a Hunchentoot webserver, you make an instance of
 342           this class or one of its subclasses and use the generic
 343           function <code><a href="#start">START</a></code> to start it (and
 344           <code><a href="#stop">STOP</a></code> to stop it).  Use the
 345           <code xmlns="http://www.w3.org/1999/xhtml">:port</code> initarg if you don't want to listen
 346           on the default http port 80.  If 0 is specified for the
 347           port, the system chooses a random port to listen on.  The
 348           port number choosen can be retrieved using the
 349           <code><a href="#acceptor-port">ACCEPTOR-PORT</a></code> accessor.  The port
 350           number chosen is retained across stopping and starting the
 351           acceptor.
 352           <p xmlns="http://www.w3.org/1999/xhtml">
 353             There are other initargs most of which you probably
 354             won't need very often.  They are explained in detail
 355             in the docstrings of the slot definitions.
 356           </p>
 357           <p xmlns="http://www.w3.org/1999/xhtml">
 358             Unless you are in a Lisp without MP capabilities, you can
 359             have several active instances of
 360             <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> (listening on different
 361             ports) at the same time.
 362           </p>
 363         </clix:description></blockquote></p>
 364
 365       <p xmlns=""><a class="none" name="ssl-acceptor"></a>
 366       [Standard class]
 367       <br><b>ssl-acceptor</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Create and <code><a href="#start">START</a></code> an instance of this class
 368         (instead of <code><a href="#acceptor">ACCEPTOR</a></code>) if you want an https server.  There are two
 369         required initargs, <code xmlns="http://www.w3.org/1999/xhtml">:SSL-CERTIFICATE-FILE</code> and <code xmlns="http://www.w3.org/1999/xhtml">:SSL-PRIVATEKEY-FILE</code>, for
 370         pathname designators denoting the certificate file and the key file in
 371         PEM format.  On LispWorks, you can have both in one file in which case
 372         the second initarg is optional.  You can also use the
 373         <code xmlns="http://www.w3.org/1999/xhtml">:SSL-PRIVATEKEY-PASSWORD</code> initarg to provide a password
 374         (as a string) for the key file (or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>, the default, for
 375         no password).
 376         <p xmlns="http://www.w3.org/1999/xhtml">
 377           The default port for <code xmlns=""><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code> instances is 443 instead of 80
 378         </p>
 379         </clix:description></blockquote></p>
 380
 381       <p xmlns=""><a class="none" name="start"></a>
 382           [Generic function]
 383           <br><b>start</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 384         </clix:lambda-list></i>
 385             =&gt;
 386             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">acceptor
 387         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Starts <code><i>acceptor</i></code> so that it begins accepting
 388         connections.  Returns the acceptor.
 389         </clix:description></blockquote></p>
 390
 391       <p xmlns=""><a class="none" name="stop"></a>
 392           [Generic function]
 393           <br><b>stop</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor &amp;key soft</clix:lambda-list></i>
 394             =&gt;
 395             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">acceptor
 396         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Stops the <code><i>acceptor</i></code> so
 397         that it no longer accepts requests.  If
 398         <code><i>soft</i></code> is true, and there are any requests
 399         in progress, wait until all requests are fully processed, but
 400         meanwhile do not accept new requests.  Note that
 401         <code><i>soft</i></code> must not be set when calling
 402         <code><a href="#stop">stop</a></code> from within a request handler, as
 403         that will deadlock.
 404         </clix:description></blockquote></p>
 405
 406       <p xmlns=""><a class="none" name="*acceptor*"></a>
 407       [Special variable]
 408       <br><b>*acceptor*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">The current ACCEPTOR object in the context of a request.
 409         </clix:description></blockquote></p>
 410
 411       <p xmlns=""><a class="none" name="acceptor-listen-backlog"></a>
 412           [Generic function]
 413           <br><b>acceptor-listen-backlog</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">listen-backlog
 414         </clix:lambda-list></i>
 415             =&gt;
 416             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">number-of-pending-connections
 417         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 418           Number of pending connections allowed in the listen socket
 419           before the kernel rejects further incoming connections.
 420           Non-LispWorks only.
 421         </clix:description></blockquote></p>
 422
 423       <p xmlns="">
 424       [Generic readers]<br><a class="none" name="acceptor-address"></a><b>acceptor-address</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 425           </clix:lambda-list></i>
 426         =&gt;
 427         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">address
 428           </clix:returns></i><br><a class="none" name="acceptor-port"></a><b>acceptor-port</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 429           </clix:lambda-list></i>
 430         =&gt;
 431         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">port
 432           </clix:returns></i><br><a class="none" name="acceptor-read-timeout"></a><b>acceptor-read-timeout</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 433           </clix:lambda-list></i>
 434         =&gt;
 435         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">read-timeout
 436           </clix:returns></i><br><a class="none" name="acceptor-ssl-certificate-file"></a><b>acceptor-ssl-certificate-file</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">ssl-acceptor
 437           </clix:lambda-list></i>
 438         =&gt;
 439         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">ssl-certificate-file
 440           </clix:returns></i><br><a class="none" name="acceptor-ssl-privatekey-file"></a><b>acceptor-ssl-privatekey-file</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">ssl-acceptor
 441           </clix:lambda-list></i>
 442         =&gt;
 443         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">ssl-privatekey-file
 444           </clix:returns></i><br><a class="none" name="acceptor-ssl-privatekey-password"></a><b>acceptor-ssl-privatekey-password</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">ssl-acceptor
 445           </clix:lambda-list></i>
 446         =&gt;
 447         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">ssl-privatekey-password
 448           </clix:returns></i><br><a class="none" name="acceptor-write-timeout"></a><b>acceptor-write-timeout</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 449           </clix:lambda-list></i>
 450         =&gt;
 451         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">write-timeout
 452           </clix:returns></i><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 453           These are readers for various slots of <code><a href="#acceptor">ACCEPTOR</a></code>
 454           objects (and some of them obviously only make sense
 455           for <code><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code> objects).  See the docstrings of
 456           these slots for more information and note that there are corresponding
 457           initargs for all of them.
 458         </clix:description></blockquote></p>
 459
 460       <p xmlns="">
 461       [Generic accessors]<br><a class="none" name="acceptor-access-log-destination"></a><b>acceptor-access-log-destination</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 462           </clix:lambda-list></i>
 463       =&gt;
 464       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">(or pathname null)
 465           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-access-log-destination</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 466           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-document-root"></a><b>acceptor-document-root</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 467           </clix:lambda-list></i>
 468       =&gt;
 469       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">(or pathname null)
 470           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-document-root</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 471           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-error-template-directory"></a><b>acceptor-error-template-directory</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 472           </clix:lambda-list></i>
 473       =&gt;
 474       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">(or pathname null)
 475           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-error-template-directory</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 476           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-input-chunking-p"></a><b>acceptor-input-chunking-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 477           </clix:lambda-list></i>
 478       =&gt;
 479       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">input-chunking-p
 480           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-input-chunking-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 481           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-message-log-destination"></a><b>acceptor-message-log-destination</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 482           </clix:lambda-list></i>
 483       =&gt;
 484       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">(or pathname null)
 485           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-message-log-destination</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 486           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-name"></a><b>acceptor-name</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 487           </clix:lambda-list></i>
 488       =&gt;
 489       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">name
 490           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-name</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 491           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-output-chunking-p"></a><b>acceptor-output-chunking-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 492           </clix:lambda-list></i>
 493       =&gt;
 494       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">output-chunking-p
 495           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-output-chunking-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 496           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-persistent-connections-p"></a><b>acceptor-persistent-connections-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 497           </clix:lambda-list></i>
 498       =&gt;
 499       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">persistent-connections-p
 500           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-persistent-connections-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 501           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-reply-class"></a><b>acceptor-reply-class</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 502           </clix:lambda-list></i>
 503       =&gt;
 504       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">reply-class
 505           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-reply-class</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 506           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="acceptor-request-class"></a><b>acceptor-request-class</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 507           </clix:lambda-list></i>
 508       =&gt;
 509       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">request-class
 510           </clix:returns></i><br><tt>(setf (</tt><b>acceptor-request-class</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 511           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 512           These are accessors for various slots of <code><a href="#acceptor">ACCEPTOR</a></code>
 513           objects.  See the docstrings of these slots for more information and
 514           note that there are corresponding initargs for all of them.
 515         </clix:description></blockquote></p>
 516
 517       <p xmlns=""><a class="none" name="acceptor-ssl-p"></a>
 518           [Generic function]
 519           <br><b>acceptor-ssl-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 520         </clix:lambda-list></i>
 521             =&gt;
 522             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">generalized-boolean
 523         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Returns a true value if <code><i>acceptor</i></code> uses SSL
 524         connections.  The default is to unconditionally return <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> and
 525         subclasses of <code><a href="#acceptor">ACCEPTOR</a></code> must specialize this method to signal that
 526         they're using secure connections - see the <code><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code> class.
 527         </clix:description></blockquote></p>
 528
 529       <p xmlns=""><a class="none" name="*default-connection-timeout*"></a>
 530       [Special variable]
 531       <br><b>*default-connection-timeout*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">The default connection timeout used when an
 532         acceptor is reading from and writing to a socket stream.  Note that
 533         some Lisps allow you to set different timeouts for reading and writing
 534         and you can specify both values via initargs when you create
 535         an <a xmlns="http://www.w3.org/1999/xhtml" href="#acceptors">acceptor</a>.
 536         </clix:description></blockquote></p>
 537
 538       <p xmlns=""><a class="none" name="acceptor-remove-session"></a>
 539           [Generic function]
 540           <br><b>acceptor-remove-session</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor session
 541         </clix:lambda-list></i>
 542             =&gt;
 543             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
 544         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 545           This function is called whenever a session in
 546           <code><a href="#acceptor">ACCEPTOR</a></code> is being destroyed because of
 547           a session timout or an explicit
 548           <code><a href="#remove-session">REMOVE-SESSION</a></code> call.
 549         </clix:description></blockquote></p>
 550
 551
 552
 553     <h4 xmlns=""><a name="acceptor-behaviour">Customizing acceptor behaviour</a></h4>
 554
 555       If you want to modify what acceptors do, you should subclass
 556       <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> (or <code xmlns=""><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code>) and
 557       specialize the generic functions that constitute their behaviour (see
 558       example below).  The life of an acceptor looks like this: It is started
 559       with the function <code xmlns=""><a href="#start">START</a></code> which immediately calls
 560       <code xmlns=""><a href="#start-listening">START-LISTENING</a></code> and then applies the function
 561       <code xmlns=""><a href="#execute-acceptor">EXECUTE-ACCEPTOR</a></code> to its <a href="#taskmasters">taskmaster</a>.  This function will eventually call
 562       <code xmlns=""><a href="#accept-connections">ACCEPT-CONNECTIONS</a></code> which is responsible for setting
 563       things up to wait for clients to connect.  For each incoming connection
 564       which comes in, <code xmlns=""><a href="#handle-incoming-connection">HANDLE-INCOMING-CONNECTION</a></code> is applied
 565       to the taskmaster which will either call
 566       <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code> directly, or will create a thread
 567       to call it.  <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code> calls
 568       <code xmlns=""><a href="#initialize-connection-stream">INITIALIZE-CONNECTION-STREAM</a></code> before it does anything
 569       else, then it selects and calls a function which handles the <a href="#requests">request</a>, and finally it sends the <a href="#replies">reply</a> to the client before it calls
 570       <code xmlns=""><a href="#reset-connection-stream">RESET-CONNECTION-STREAM</a></code>.  If the connection is
 571       persistent, this procedure is repeated (except for the intialization step)
 572       in a loop until the connection is closed.  The acceptor is stopped with
 573       <code xmlns=""><a href="#stop">STOP</a></code>.
 574
 575       <p>
 576         If you just want to use the standard acceptors that come with
 577         Hunchentoot, you don't need to know anything about the functions
 578         listed in this section.
 579       </p>
 580
 581       <p xmlns=""><a class="none" name="start-listening"></a>
 582           [Generic function]
 583           <br><b>start-listening</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 584         </clix:lambda-list></i>
 585             =&gt;
 586             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
 587         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Sets up a listen socket for the given acceptor and
 588         enables it to listen to incoming connections.  This function is called
 589         from the thread that starts the acceptor initially and may return
 590         errors resulting from the listening operation (like 'address in use'
 591         or similar).
 592         </clix:description></blockquote></p>
 593
 594       <p xmlns=""><a class="none" name="accept-connections"></a>
 595           [Generic function]
 596           <br><b>accept-connections</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 597         </clix:lambda-list></i>
 598             =&gt;
 599             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">nil
 600         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">In a loop, accepts a connection and hands it over
 601         to the acceptor's taskmaster for processing using
 602         <code><a href="#handle-incoming-connection">HANDLE-INCOMING-CONNECTION</a></code>. On LispWorks, this
 603         function returns immediately, on other Lisps it returns only once the
 604         acceptor has been stopped.
 605         </clix:description></blockquote></p>
 606
 607       <p xmlns=""><a class="none" name="process-connection"></a>
 608           [Generic function]
 609           <br><b>process-connection</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor socket
 610         </clix:lambda-list></i>
 611             =&gt;
 612             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">nil
 613         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 614           This function is called by the taskmaster when a new client
 615           connection has been established.  Its arguments are the
 616           <code><a href="#acceptor">ACCEPTOR</a></code> object and a LispWorks socket
 617           handle or a usocket socket stream object in
 618           <code><i>socket</i></code>.  It reads the request headers,
 619           sets up the <a xmlns="http://www.w3.org/1999/xhtml" href="#requests">request</a> and <a xmlns="http://www.w3.org/1999/xhtml" href="#replies">reply</a> objects, and hands over to
 620           <code><a href="#process-request">PROCESS-REQUEST</a></code> which calls
 621           <code><a href="#handle-request">HANDLE-REQUEST</a></code> to select and call a
 622           handler for the request and sends its reply to the client.
 623           This is done in a loop until the stream has to be closed or
 624           until a connection timeout occurs.  It is probably not a
 625           good idea to re-implement this method until you really,
 626           really know what you're doing.
 627           <p xmlns="http://www.w3.org/1999/xhtml">
 628             Handlers may call to the
 629             <code xmlns=""><a href="#detach-socket">DETACH-SOCKET</a></code> generic function to
 630             indicate that no further requests should be handled on
 631             the connection by Hunchentoot, and that responsibility for
 632             the socket is assumed by third-party software.  This can
 633             be used by specialized handlers that wish to hand over
 634             connection polling or processing to functions outside of
 635             Hunchentoot, i.e. for connection multiplexing or
 636             implementing specialized client protocols.  Hunchentoot
 637             will finish processing the request and the
 638             <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code> function will
 639             return without closing the connection.  At that point,
 640             the acceptor may interact with the socket in whatever
 641             fashion required.
 642           </p>
 643         </clix:description></blockquote></p>
 644
 645       <p xmlns=""><a class="none" name="detach-socket"></a>
 646           [Generic function]
 647           <br><b>detach-socket</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
 648         </clix:lambda-list></i>
 649             =&gt;
 650             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">stream
 651         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 652           Indicate to Hunchentoot that it should stop serving requests
 653           on the current request's socket.  Hunchentoot will finish
 654           processing the current request and then return from
 655           <code><a href="#process-connection">PROCESS-CONNECTION</a></code> without closing the
 656           connection to the client.
 657           <code><a href="#detach-socket">DETACH-SOCKET</a></code> can only be called from
 658           within a request handler function.
 659         </clix:description></blockquote></p>
 660
 661       <p xmlns=""><a class="none" name="initialize-connection-stream"></a>
 662           [Generic function]
 663           <br><b>initialize-connection-stream</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor stream
 664         </clix:lambda-list></i>
 665             =&gt;
 666             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">stream
 667         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 668           Can be used to modify the stream which is used to
 669           communicate between client and server before the request is
 670           read.  The default method of <code><a href="#acceptor">ACCEPTOR</a></code>
 671           does nothing, but see for example the method defined for
 672           <code><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code>.  All methods of this
 673           generic function <em xmlns="http://www.w3.org/1999/xhtml">must</em> return the stream to use.
 674         </clix:description></blockquote></p>
 675
 676       <p xmlns=""><a class="none" name="reset-connection-stream"></a>
 677           [Generic function]
 678           <br><b>reset-connection-stream</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor stream
 679         </clix:lambda-list></i>
 680             =&gt;
 681             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">stream
 682         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 683           Resets the stream which is used to communicate
 684           between client and server after one request has been served so that it
 685           can be used to process the next request.  This generic function is
 686           called after a request has been processed and <em xmlns="http://www.w3.org/1999/xhtml">must</em> return the
 687           stream.
 688         </clix:description></blockquote></p>
 689
 690       <p xmlns=""><a class="none" name="acceptor-log-access"></a>
 691           [Generic function]
 692           <br><b>acceptor-log-access</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor &amp;key return-code</clix:lambda-list></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 693           Function to call to log access to the acceptor.  The
 694           <code><i>return-code</i></code> keyword argument contains additional
 695           information about the request to log.  In addition, it can use the
 696           standard request and reply accessor functions that are available to
 697           handler functions to find out more information about the request.
 698         </clix:description></blockquote></p>
 699
 700       <p xmlns=""><a class="none" name="acceptor-log-message"></a>
 701           [Generic function]
 702           <br><b>acceptor-log-message</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor log-level format-string &amp;rest format-arguments</clix:lambda-list></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 703           Function to call to log messages by the <code><i>acceptor</i></code>.  It must accept
 704           a severity level for the message, which will be one of :ERROR, :INFO,
 705           or :WARNING, a format string and an arbitary number of formatting
 706           arguments.
 707         </clix:description></blockquote></p>
 708
 709       <p xmlns=""><a class="none" name="acceptor-status-message"></a>
 710           [Generic function]
 711           <br><b>acceptor-status-message</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor http-return-code &amp;key &amp;allow-other-keys</clix:lambda-list></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 712           This function is called when a request's handler has been
 713           called but failed to provide content to send back to the
 714           client.  It converts the
 715           <code><i>HTTP-STATUS-CODE</i></code> to some request
 716           contents, typically a human readable description of the
 717           status code to be displayed to the user.
 718
 719           If an ERROR-TEMPLATE-DIRECTORY is set in the current
 720           acceptor and the directory contains a file corresponding to
 721           HTTP-STATUS-CODE named &lt;code&gt;.html, that file is sent
 722           to the client after variable substitution.  Variables are
 723           referenced by ${&lt;variable-name&gt;}.
 724
 725           Additional keyword arguments may be provided which are made
 726           available to the templating logic as substitution variables.
 727           These variables can be interpolated into error message
 728           templates in, which contains the current URL relative to the
 729           server and without GET parameters.
 730
 731           In addition to the variables corresponding to keyword
 732           arguments, the script-name, lisp-implementation-type,
 733           lisp-implementation-version and hunchentoot-version
 734           variables are available.
 735         </clix:description></blockquote></p>
 736
 737
 738   <h4 xmlns=""><a name="subclassing-acceptors">An example of how to subclass ACCEPTOR</a></h4>
 739
 740     This example shows how to subclass <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> in order to
 741     provide Hunchentoot with basic virtual host support.  It assumes
 742     Hunchentoot is sitting behind an Internet-facing reverse-proxy web server
 743     that maps the host (or domain) part of incoming HTTP requests to unique
 744     localhost ports.
 745
 746     <pre>(asdf:load-system "hunchentoot")
 747 (asdf:load-system "drakma")
 748
 749 ;;; Subclass ACCEPTOR
 750 (defclass vhost (tbnl:acceptor)
 751   ;; slots
 752   ((dispatch-table
 753     :initform '()
 754     :accessor dispatch-table
 755     :documentation "List of dispatch functions"))
 756   ;; options
 757   (:default-initargs                    ; default-initargs must be used
 758    :address "127.0.0.1"))               ; because ACCEPTOR uses it
 759
 760 ;;; Specialise ACCEPTOR-DISPATCH-REQUEST for VHOSTs
 761 (defmethod tbnl:acceptor-dispatch-request ((vhost vhost) request)
 762   ;; try REQUEST on each dispatcher in turn
 763   (mapc (lambda (dispatcher)
 764           (let ((handler (funcall dispatcher request)))
 765             (when handler               ; Handler found. FUNCALL it and return result
 766               (return-from tbnl:acceptor-dispatch-request (funcall handler)))))
 767         (dispatch-table vhost))
 768   (call-next-method))
 769
 770 ;;; ======================================================================
 771 ;;; Now all we need to do is test it
 772
 773 ;;; Instantiate VHOSTs
 774 (defvar vhost1 (make-instance 'vhost :port 50001))
 775 (defvar vhost2 (make-instance 'vhost :port 50002))
 776
 777 ;;; Populate each dispatch table
 778 (push
 779  (tbnl:create-prefix-dispatcher "/foo" 'foo1)
 780  (dispatch-table vhost1))
 781 (push
 782  (tbnl:create-prefix-dispatcher "/foo" 'foo2)
 783  (dispatch-table vhost2))
 784
 785 ;;; Define handlers
 786 (defun foo1 () "Hello")
 787 (defun foo2 () "Goodbye")
 788
 789 ;;; Start VHOSTs
 790 (tbnl:start vhost1)
 791 (tbnl:start vhost2)
 792
 793 ;;; Make some requests
 794 (drakma:http-request "http://127.0.0.1:50001/foo")
 795 ;;; =|
 796 ;;; 127.0.0.1 - [2012-06-08 14:30:39] "GET /foo HTTP/1.1" 200 5 "-" "Drakma/1.2.6 (SBCL 1.0.56; Linux; 2.6.32-5-686; http://weitz.de/drakma/)"
 797 ;;; =&gt;
 798 ;;; "Hello"
 799 ;;; 200
 800 ;;; ((:CONTENT-LENGTH . "5") (:DATE . "Fri, 08 Jun 2012 14:30:39 GMT")
 801 ;;;  (:SERVER . "Hunchentoot 1.2.3") (:CONNECTION . "Close")
 802 ;;;  (:CONTENT-TYPE . "text/html; charset=utf-8"))
 803 ;;; #&lt;PURI:URI http://127.0.0.1:50001/foo&gt;
 804 ;;; #&lt;FLEXI-STREAMS:FLEXI-IO-STREAM {CA90059}&gt;
 805 ;;; T
 806 ;;; "OK"
 807 (drakma:http-request "http://127.0.0.1:50002/foo")
 808 ;;; =|
 809 ;;; 127.0.0.1 - [2012-06-08 14:30:47] "GET /foo HTTP/1.1" 200 7 "-" "Drakma/1.2.6 (SBCL 1.0.56; Linux; 2.6.32-5-686; http://weitz.de/drakma/)"
 810 ;;; =&gt;
 811 ;;; "Goodbye"
 812 ;;; 200
 813 ;;; ((:CONTENT-LENGTH . "7") (:DATE . "Fri, 08 Jun 2012 14:30:47 GMT")
 814 ;;;  (:SERVER . "Hunchentoot 1.2.3") (:CONNECTION . "Close")
 815 ;;;  (:CONTENT-TYPE . "text/html; charset=utf-8"))
 816 ;;; #&lt;PURI:URI http://127.0.0.1:50002/foo&gt;
 817 ;;; #&lt;FLEXI-STREAMS:FLEXI-IO-STREAM {CAE8059}&gt;
 818 ;;; T
 819 ;;; "OK"</pre>
 820
 821     How to make each VHOST write to separate access log streams (or files) is
 822     left as an exercise to the reader.
 823
 824
 825
 826     <h4 xmlns=""><a name="taskmasters">Taskmasters</a></h4>
 827       As a "normal" Hunchentoot user, you can completely ignore
 828       taskmasters and skip this section.  But if you're still reading,
 829       here are the dirty details: Each <a href="#acceptors">acceptor</a> has a taskmaster associated with
 830       it at creation time.  It is the taskmaster's job to distribute
 831       the work of accepting and handling incoming connections.  The
 832       acceptor calls the taskmaster if appropriate and the taskmaster
 833       calls back into the acceptor.  This is done using the generic
 834       functions described in this and the <a href="#acceptor-behaviour">previous</a> section.  Hunchentoot
 835       comes with two standard taskmaster implementations - one (which
 836       is the default used on multi-threaded Lisps) which starts a new
 837       thread for each incoming connection and one which handles all
 838       requests sequentially.  It should for example be relatively
 839       straightforward to create a taskmaster which allocates threads
 840       from a fixed pool instead of creating a new one for each
 841       connection.
 842
 843       <p>
 844         You can control the resources consumed by a threaded taskmaster via
 845         two initargs. <code>:max-thread-count</code> lets you set the maximum
 846         number of request threads that can be processes simultaneously.  If
 847         this is <code>nil</code>, the is no thread limit imposed.
 848
 849         <code>:max-accept-count</code> lets you set the maximum number of requests
 850         that can be outstanding (i.e. being processed or queued for processing).
 851
 852         If <code>:max-thread-count</code> is supplied and <code>:max-accept-count</code>
 853         is <code>NIL</code>, then a <code xmlns=""><a href="#+http-service-unavailable+">+HTTP-SERVICE-UNAVAILABLE+</a></code>
 854         error will be generated if there are more than the max-thread-count
 855         threads processing requests.  If both <code>:max-thread-count</code>
 856         and <code>:max-accept-count</code> are supplied, then max-thread-count
 857         must be less than max-accept-count; if more than max-thread-count
 858         requests are being processed, then requests up to max-accept-count
 859         will be queued until a thread becomes available.  If more than
 860         max-accept-count requests are outstanding, then a <code xmlns=""><a href="#+http-service-unavailable+">+HTTP-SERVICE-UNAVAILABLE+</a></code>
 861         error will be generated.
 862
 863         In a load-balanced environment with multiple Hunchentoot servers, it's
 864         reasonable to provide <code>:max-thread-count</code> but leave
 865         <code>:max-accept-count</code> null.   This will immediately result
 866         in <code xmlns=""><a href="#+http-service-unavailable+">+HTTP-SERVICE-UNAVAILABLE+</a></code> when one server is
 867         out of resources, so the load balancer can try to find another server.
 868
 869         In an environment with a single Hunchentoot server, it's reasonable
 870         to provide both <code>:max-thread-count</code> and a somewhat larger value
 871         for <code>:max-accept-count</code>.  This will cause a server that's almost
 872         out of resources to wait a bit; if the server is completely out of resources,
 873         then the reply will be <code xmlns=""><a href="#+http-service-unavailable+">+HTTP-SERVICE-UNAVAILABLE+</a></code>.
 874         The default for these values is 100 and 120, respectively.
 875       </p>
 876
 877       <p>
 878         If you want to implement your own taskmasters, you should subclass
 879         <code xmlns=""><a href="#taskmaster">TASKMASTER</a></code> or one of its subclasses,
 880         <code xmlns=""><a href="#single-threaded-taskmaster">SINGLE-THREADED-TASKMASTER</a></code> or
 881         <code xmlns=""><a href="#one-thread-per-connection-taskmaster">ONE-THREAD-PER-CONNECTION-TASKMASTER</a></code>, and
 882         specialize the generic functions in this section.
 883       </p>
 884
 885       <p xmlns=""><a class="none" name="taskmaster"></a>
 886       [Standard class]
 887       <br><b>taskmaster</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 888           An instance of this class is responsible for distributing
 889           the work of handling requests for its acceptor.  This is an
 890           "abstract" class in the sense that usually only instances of
 891           subclasses of <code><a href="#taskmaster">TASKMASTER</a></code> will be used.
 892         </clix:description></blockquote></p>
 893
 894       <p xmlns=""><a class="none" name="one-thread-per-connection-taskmaster"></a>
 895       [Standard class]
 896       <br><b>one-thread-per-connection-taskmaster</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 897           A taskmaster that starts one thread for listening to
 898           incoming requests and one thread for each incoming
 899           connection.
 900           <p xmlns="http://www.w3.org/1999/xhtml">
 901             This is the default taskmaster implementation for multi-threaded Lisp
 902             implementations.
 903           </p>
 904         </clix:description></blockquote></p>
 905
 906       <p xmlns=""><a class="none" name="single-threaded-taskmaster"></a>
 907       [Standard class]
 908       <br><b>single-threaded-taskmaster</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 909           A taskmaster that runs synchronously in the
 910           thread where the <code><a href="#start">START</a></code> function was invoked (or
 911           in the case of LispWorks in the thread started
 912           by <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/lw51/LWRM/html/lwref-61.htm#marker-910861"><code>COMM:START-UP-SERVER</code></a>).
 913           This is the simplest possible taskmaster implementation in that its
 914           methods do nothing but calling their acceptor "sister"
 915           methods - <code><a href="#execute-acceptor">EXECUTE-ACCEPTOR</a></code> calls <code><a href="#accept-connections">ACCEPT-CONNECTIONS</a></code>,
 916           <code><a href="#handle-incoming-connection">HANDLE-INCOMING-CONNECTION</a></code> calls <code><a href="#process-connection">PROCESS-CONNECTION</a></code>.
 917         </clix:description></blockquote></p>
 918
 919       <p xmlns=""><a class="none" name="multi-threaded-taskmaster"></a>
 920       [Standard class]
 921       <br><b>multi-threaded-taskmaster</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 922           This is an abstract class for taskmasters that use multiple threads;
 923           it is not a concrete class and you should not instantiate it with
 924           <code xmlns="http://www.w3.org/1999/xhtml">MAKE-INSTANCE</code>.
 925           Instead, you should instantiate its subclass
 926           <code><a href="#one-thread-per-connection-taskmaster">ONE-THREAD-PER-CONNECTION-TASKMASTER</a></code> described above.
 927           <code><a href="#multi-threaded-taskmaster">MULTI-THREADED-TASKMASTER</a></code>
 928           is intended to be inherited from by extensions to Hunchentoot,
 929           such as <a xmlns="http://www.w3.org/1999/xhtml" href="http://common-lisp.net/project/qitab/">quux-hunchentoot</a>'s
 930           <code xmlns="http://www.w3.org/1999/xhtml">THREAD-POOLING-TASKMASTER</code>,
 931           though at the moment, doing so only inherits one slot and one method,
 932           on <code><a href="#execute-acceptor">EXECUTE-ACCEPTOR</a></code>,
 933           to have it start a new thread for the acceptor,
 934           then saved in said slot.
 935         </clix:description></blockquote></p>
 936
 937       <p xmlns=""><a class="none" name="execute-acceptor"></a>
 938           [Generic function]
 939           <br><b>execute-acceptor</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster
 940         </clix:lambda-list></i>
 941             =&gt;
 942             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
 943         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">This is a callback called by the acceptor once it
 944         has performed all initial processing to start listening for incoming
 945         connections (see <code><a href="#start-listening">START-LISTENING</a></code>).  It usually calls the
 946         <code><a href="#accept-connections">ACCEPT-CONNECTIONS</a></code> method of the acceptor, but depending on the
 947         taskmaster instance the method might be called from a new thread.
 948         </clix:description></blockquote></p>
 949
 950       <p xmlns=""><a class="none" name="handle-incoming-connection"></a>
 951           [Generic function]
 952           <br><b>handle-incoming-connection</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster socket
 953         </clix:lambda-list></i>
 954             =&gt;
 955             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
 956         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
 957           This function is called by the acceptor to start
 958           processing of requests on a new incoming connection.  <code><i>socket</i></code> is the
 959           usocket instance that represents the new connection (or a socket
 960           handle on LispWorks).  The taskmaster starts processing requests on
 961           the incoming connection by calling the <code><a href="#process-connection">PROCESS-CONNECTION</a></code>
 962           method of the acceptor instance.  The <code><i>socket</i></code> argument is passed to
 963           <code><a href="#process-connection">PROCESS-CONNECTION</a></code> as an argument.
 964
 965           If the taskmaster is a multi-threaded taskmaster, <code><a href="#handle-incoming-thread">HANDLE-INCOMING-THREAD</a></code>
 966           will call <code><a href="#create-request-handler-thread">CREATE-REQUEST-HANDLER-THREAD</a></code>, which will call
 967           <code><a href="#process-connection">PROCESS-CONNECTION</a></code> in a new thread.
 968           <code><a href="#handle-incoming-thread">HANDLE-INCOMING-THREAD</a></code> might issue a
 969           <code><a href="#+http-service-unavailable+">+HTTP-SERVICE-UNAVAILABLE+</a></code> error
 970           if there are too many request threads or it might block waiting for a
 971           request thread to finish.
 972               </clix:description></blockquote></p>
 973
 974             <p xmlns=""><a class="none" name="start-thread"></a>
 975           [Generic function]
 976           <br><b>start-thread</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster thunk &amp;key
 977             </clix:lambda-list></i>
 978             =&gt;
 979             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">thread
 980             </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">This function is a callback that
 981                 starts a new thread that will call the given <code><i>thunk</i></code>
 982                 in the context of the proper <code><i>taskmaster</i></code>,
 983                 with appropriate context-dependent keyword arguments.
 984                 <code><a href="#one-thread-per-connection-taskmaster">ONE-THREAD-PER-CONNECTION-TASKMASTER</a></code> uses it in
 985                 <code><a href="#execute-acceptor">EXECUTE-ACCEPTOR</a></code>
 986                 and <code><a href="#create-request-handler-thread">CREATE-REQUEST-HANDLER-THREAD</a></code>,
 987                 but specialized taskmasters may define more functions that use it.
 988                 By default, it just creates a thread calling the thunk
 989                 with a specified <code><i>name</i></code> keyword argument.
 990                 Specialized taskmasters may wrap special bindings and condition handlers
 991                 around the thunk call, register the thread in a management table, etc.
 992               </clix:description></blockquote></p>
 993
 994             <p xmlns=""><a class="none" name="create-request-handler-thread"></a>
 995           [Generic function]
 996           <br><b>create-request-handler-thread</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster socket
 997             </clix:lambda-list></i>
 998             =&gt;
 999             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">thread
1000             </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">This function is called by <code><a href="#handle-incoming-thread">HANDLE-INCOMING-THREAD</a></code>
1001           to create a new thread which calls <code><a href="#process-connection">PROCESS-CONNECTION</a></code>.
1002           If you specialize this function, you must be careful to have the thread
1003           call <code><a href="#decrement-taskmaster-request-count">DECREMENT-TASKMASTER-REQUEST-COUNT</a></code> before
1004           it exits.  A typical method will look like this:
1005
1006                 <pre xmlns="http://www.w3.org/1999/xhtml">(defmethod create-request-handler-thread ((taskmaster monitor-taskmaster) socket)
1007   (bt:make-thread
1008    (lambda ()
1009      (with-monitor-error-handlers
1010          (unwind-protect
1011               (with-monitor-variable-bindings
1012                   (process-connection (taskmaster-acceptor taskmaster) socket))
1013            (decrement-taskmaster-request-count taskmaster))))))</pre>
1014
1015
1016
1017
1018
1019
1020
1021         </clix:description></blockquote></p>
1022
1023       <p xmlns=""><a class="none" name="shutdown"></a>
1024           [Generic function]
1025           <br><b>shutdown</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster
1026         </clix:lambda-list></i>
1027             =&gt;
1028             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">taskmaster
1029         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Shuts down the taskmaster, i.e. frees all resources
1030         that were set up by it.  For example, a multi-threaded taskmaster
1031         might terminate all threads that are currently associated with it.
1032         This function is called by the acceptor's <code><a href="#stop">STOP</a></code> method.
1033         </clix:description></blockquote></p>
1034
1035       <p xmlns=""><a class="none" name="taskmaster-acceptor"></a>
1036       [Generic accessor]
1037       <br><b>taskmaster-acceptor</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster
1038         </clix:lambda-list></i>
1039       =&gt;
1040       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">acceptor
1041         </clix:returns></i><br><tt>(setf (</tt><b>taskmaster-acceptor</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">taskmaster
1042         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1043           This is an accessor for the slot of a <code><a href="#taskmaster">TASKMASTER</a></code>
1044           object that links back to the <a xmlns="http://www.w3.org/1999/xhtml" href="#acceptors">acceptor</a> it is
1045           associated with.
1046         </clix:description></blockquote></p>
1047
1048
1049
1050     <h4 xmlns=""><a name="request-dispatch">Request dispatch and handling</a></h4>
1051
1052       The main job of <code xmlns=""><a href="#handle-request">HANDLE-REQUEST</a></code> is to select
1053       and call a function which handles the request, i.e. which looks
1054       at the data the client has sent and prepares an appropriate
1055       reply to send back.  This is by default implemented as follows:
1056       <p>
1057         The ACCEPTOR class defines a
1058         <code xmlns=""><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code> generic
1059         function which is used to actually dispatch the request.  This
1060         function is called by the default method of
1061         <code xmlns=""><a href="#handle-request">HANDLE-REQUEST</a></code>.  Each
1062         <code xmlns=""><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code> method looks at
1063         the request object and depending on its contents decides to
1064         either handle the request or call the next method.
1065       </p>
1066       <p>
1067         In order to dispatch a request, Hunchentoot calls the
1068         <code xmlns=""><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code> generic
1069         functions.  The method for <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> tries
1070         to serve a static file relative to it's
1071         <code xmlns=""><a href="#acceptor-document-root">ACCEPTOR-DOCUMENT-ROOT</a></code>.  Application
1072         specific acceptor subclasses will typically perform URL
1073         parsing and dispatching according to the policy that is
1074         required.
1075       </p>
1076       <p>
1077         The default method of <code xmlns=""><a href="#handle-request">HANDLE-REQUEST</a></code> sets
1078         up <a href="#logging">standard logging and error handling</a>
1079         before it calls the acceptor's request dispatcher.
1080       </p>
1081       <p>
1082         Request handlers do their work by modifying
1083         the <a href="#replies">reply object</a> if necessary and by eventually
1084         returning the response body in the form of a string or a binary
1085         sequence.  As an alternative, they can also
1086         call <code xmlns=""><a href="#send-headers">SEND-HEADERS</a></code> and write directly to a stream.
1087       </p>
1088
1089
1090     <h4 xmlns=""><a name="easy-handlers">Using the easy-handler framework</a></h4>
1091       <p>
1092         The <code xmlns=""><a href="#easy-acceptor">EASY-ACCEPTOR</a></code> class defines a method
1093         for <code xmlns=""><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code> that walks
1094         through the list <code xmlns=""><a href="#*dispatch-table*">*DISPATCH-TABLE*</a></code> which
1095         consists of <em>dispatch functions</em>.  Each of these
1096         functions accepts the request object as its only argument and
1097         either returns a request handler to handle the request or
1098         <code>NIL</code> which means that the next dispatcher in the
1099         list will be tried. A <em>request handler</em> is a function
1100         of zero arguments which relies on the special variable
1101         <code xmlns=""><a href="#*request*">*REQUEST*</a></code> to access the request instance
1102         being serviced. If all dispatch functions return
1103         <code>NIL</code>, the next
1104         <code xmlns=""><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code> will be called.
1105       </p>
1106       <p>
1107         <strong>N.B.</strong> All functions and variables in this
1108         section are related to the easy request dispatch mechanism and
1109         are meaningless if you're using your own request dispatcher.
1110       </p>
1111
1112       <p xmlns=""><a class="none" name="easy-acceptor"></a>
1113       [Standard class]
1114       <br><b>easy-acceptor</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1115           This class defines no additional slots with respect to
1116           <code><a href="#acceptor">ACCEPTOR</a></code>.  It only serves as an
1117           additional type for dispatching calls to
1118           <code><a href="#acceptor-dispatch-request">ACCEPTOR-DISPATCH-REQUEST</a></code>.  In order to
1119           use the easy handler framework, acceptors of this class or
1120           one of its subclasses must be used.
1121         </clix:description></blockquote></p>
1122
1123       <p xmlns=""><a class="none" name="easy-ssl-acceptor"></a>
1124       [Standard class]
1125       <br><b>easy-ssl-acceptor</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1126           This class mixes the <code><a href="#ssl-acceptor">SSL-ACCEPTOR</a></code> and
1127           the <code><a href="#easy-acceptor">EASY-ACCEPTOR</a></code> classes.  It is used
1128           when both ssl and the easy handler framework are required.
1129         </clix:description></blockquote></p>
1130
1131       <p xmlns=""><a class="none" name="*dispatch-table*"></a>
1132       [Special variable]
1133       <br><b>*dispatch-table*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1134           A global list of dispatch functions.  The initial value is a
1135           list consisting of the symbol
1136           <code><a href="#dispatch-easy-handlers">DISPATCH-EASY-HANDLERS</a></code>.
1137         </clix:description></blockquote></p>
1138
1139       <p xmlns=""><a class="none" name="create-prefix-dispatcher"></a>
1140           [Function]
1141           <br><b>create-prefix-dispatcher</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">prefix handler</clix:lambda-list></i>
1142             =&gt;
1143             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">dispatch-fn</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1144           A convenience function which will return a dispatcher that
1145           returns <code><i>handler</i></code> whenever the path part of
1146           the request URI starts with the
1147           string <code><i>prefix</i></code>.
1148         </clix:description></blockquote></p>
1149
1150       <p xmlns=""><a class="none" name="create-regex-dispatcher"></a>
1151           [Function]
1152           <br><b>create-regex-dispatcher</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">regex handler</clix:lambda-list></i>
1153             =&gt;
1154             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">dispatch-fn</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1155           A convenience function which will return a dispatcher that
1156           returns <code><i>handler</i></code> whenever the path part of
1157           the request URI matches
1158           the <a xmlns="http://www.w3.org/1999/xhtml" href="http://weitz.de/cl-ppcre/">CL-PPCRE</a> regular
1159           expression <code><i>regex</i></code> (which can be a string, an
1160           s-expression, or a scanner).
1161         </clix:description></blockquote></p>
1162
1163       <p xmlns=""><a class="none" name="create-folder-dispatcher-and-handler"></a>
1164           [Function]
1165           <br><b>create-folder-dispatcher-and-handler</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">uri-prefix base-path <tt>&amp;optional</tt> content-type</clix:lambda-list></i>
1166             =&gt;
1167             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">dispatch-fn</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1168           Creates and returns a dispatch function which will dispatch to
1169           a handler function which emits the file relative
1170           to <code><i>base-path</i></code> that is denoted by the URI of
1171           the request relative
1172           to <code><i>uri-prefix</i></code>.  <code><i>uri-prefix</i></code>
1173           must be a string ending with a
1174           slash, <code><i>base-path</i></code> must be a pathname
1175           designator for an existing directory.
1176           Uses <code><a href="#handle-static-file">HANDLE-STATIC-FILE</a></code> internally.
1177           <p xmlns="http://www.w3.org/1999/xhtml">
1178             If <code xmlns=""><i>content-type</i></code> is <em>not</em>
1179             <code>NIL</code>, it will be used as a the content type for
1180             all files in the folder.  Otherwise (which is the default)
1181             the content type of each file will be
1182             determined <a href="#handle-static-file">as usual</a>.
1183           </p>
1184         </clix:description></blockquote></p>
1185
1186       <p xmlns=""><a class="none" name="create-static-file-dispatcher-and-handler"></a>
1187           [Function]
1188           <br><b>create-static-file-dispatcher-and-handler</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">uri path
1189         <tt>&amp;optional
1190         </tt> content-type
1191         </clix:lambda-list></i>
1192             =&gt;
1193             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
1194         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1195           Creates and returns a request dispatch function which will
1196           dispatch to a handler function which emits the file denoted
1197           by the pathname designator PATH with content type
1198           CONTENT-TYPE if the SCRIPT-NAME of the request matches the
1199           string URI.  If CONTENT-TYPE is NIL, tries to determine the
1200           content type via the file's suffix.
1201         </clix:description></blockquote></p>
1202
1203       <p xmlns=""><a class="none" name="define-easy-handler"></a>
1204           [Macro]
1205           <br><b>define-easy-handler</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">description lambda-list [[declaration* | documentation]] form*</clix:lambda-list></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1206           Defines a handler as if
1207           by <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/m_defun.htm">
1208             <code>DEFUN</code></a> and optionally registers it with a
1209           URI so that it will be found
1210           by <code><a href="#dispatch-easy-handlers">DISPATCH-EASY-HANDLERS</a></code>.
1211           <p xmlns="http://www.w3.org/1999/xhtml">
1212             <code xmlns=""><i>description</i></code> is either a
1213             symbol <code xmlns=""><i>name</i></code> or a list matching the
1214             <a href="http://www.lispworks.com/documentation/HyperSpec/Body/03_de.htm">destructuring
1215               lambda list</a>
1216           </p>
1217           <pre xmlns="http://www.w3.org/1999/xhtml">(name &amp;key uri acceptor-names default-parameter-type default-request-type).</pre>
1218           <code><i>lambda-list</i></code> is a list the elements of which
1219           are either a symbol <code><i>var</i></code> or a list matching
1220           the destructuring lambda list
1221           <pre xmlns="http://www.w3.org/1999/xhtml">(var &amp;key real-name parameter-type init-form request-type).</pre>
1222           The resulting handler will be a Lisp function with the
1223           name <code><i>name</i></code> and keyword parameters named by
1224           the <code><i>var</i></code> symbols.
1225           Each <code><i>var</i></code> will be bound to the value of the
1226           GET or POST parameter called <code><i>real-name</i></code> (a
1227           string) before the body of the function is executed.
1228           If <code><i>real-name</i></code> is not provided, it will be
1229           computed
1230           by <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/f_stg_up.htm#string-downcase">downcasing</a>
1231           the symbol name of <code><i>var</i></code>.
1232           <p xmlns="http://www.w3.org/1999/xhtml">
1233             If <code xmlns=""><i>uri</i></code> (which is evaluated) is provided,
1234             then it must be a string or
1235             a <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_f.htm#function_designator">function
1236               designator</a> for a unary function.  In this case, the
1237             handler will be returned
1238             by <code xmlns=""><a href="#dispatch-easy-handlers">DISPATCH-EASY-HANDLERS</a></code>,
1239             if <code xmlns=""><i>uri</i></code> is a string and
1240             the <a href="#script-name">script name</a> of the current
1241             request is <code xmlns=""><i>uri</i></code>, or
1242             if <code xmlns=""><i>uri</i></code> designates a function and applying
1243             this function to
1244             the <a href="#*request*">current <code>REQUEST</code>
1245               object</a> returns a true value.
1246           </p>
1247           <p xmlns="http://www.w3.org/1999/xhtml">
1248             <code xmlns=""><i>acceptor-names</i></code> (which is evaluated) can be a
1249             list of symbols which means that the handler will only be
1250             returned by <code xmlns=""><a href="#dispatch-easy-handlers">DISPATCH-EASY-HANDLERS</a></code> in
1251             acceptors which have one of these names
1252             (see <code xmlns=""><a href="#acceptor-name">ACCEPTOR-NAME</a></code>).  <code xmlns=""><i>acceptor-names</i></code> can also be the
1253             symbol <code>T</code> which means that the handler will be
1254             returned by <code xmlns=""><a href="#dispatch-easy-handlers">DISPATCH-EASY-HANDLERS</a></code>
1255             in <em>every</em> acceptor.
1256           </p>
1257           <p xmlns="http://www.w3.org/1999/xhtml">
1258             Whether the GET or POST parameter (or both) will be taken into
1259             consideration, depends on <code xmlns=""><i>request-type</i></code>
1260             which can
1261             be <code>:GET</code>, <code>:POST</code>, <code>:BOTH</code>,
1262             or <code>NIL</code>.  In the last case, the value of
1263             <code xmlns=""><i>default-request-type</i></code> (the default of which
1264             is <code>:BOTH</code>) will be used.
1265           </p>
1266           <p xmlns="http://www.w3.org/1999/xhtml">
1267             The value of <code xmlns=""><i>var</i></code> will usually be a string
1268             (unless it resulted from a <a href="#upload">file upload</a>
1269             in which case it won't be converted at all), but
1270             if <code xmlns=""><i>parameter-type</i></code> (which is evaluated) is
1271             provided, the string will be converted to another Lisp type by
1272             the following rules:
1273           </p>
1274           <p xmlns="http://www.w3.org/1999/xhtml">
1275             If the corresponding GET or POST parameter wasn't provided by
1276             the client, <code xmlns=""><i>var</i></code>'s value will
1277             be <code>NIL</code>.  If <code xmlns=""><i>parameter-type</i></code>
1278             is <code>'STRING</code>,
1279             <code xmlns=""><i>var</i></code>'s value remains as is.
1280             If <code xmlns=""><i>parameter-type</i></code> is <code>'INTEGER</code>
1281             and the parameter string consists solely of decimal
1282             digits, <code xmlns=""><i>var</i></code>'s value will be the
1283             corresponding integer, otherwise <code>NIL</code>.
1284             If <code xmlns=""><i>parameter-type</i></code> is
1285             <code>'KEYWORD</code>, <code xmlns=""><i>var</i></code>'s value will be
1286             the keyword obtained
1287             by <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_intern.htm">interning</a>
1288             the <a href="http://www.lispworks.com/documentation/HyperSpec/Body/f_stg_up.htm#string-upcase">upcased</a>
1289             parameter string into
1290             the <a href="http://www.lispworks.com/documentation/HyperSpec/Body/11_abc.htm">keyword
1291               package</a>.  If <code xmlns=""><i>parameter-type</i></code>
1292             is <code>'CHARACTER</code> and the parameter string is of
1293             length one, <code xmlns=""><i>var</i></code>'s value will be the single
1294             character of this string, otherwise <code>NIL</code>.
1295             If <code xmlns=""><i>parameter-type</i></code>
1296             is <code>'BOOLEAN</code>, <code xmlns=""><i>var</i></code>'s value will
1297             always be <code>T</code> (unless it is <code>NIL</code> by the
1298             first rule above, of course).
1299             If <code xmlns=""><i>parameter-type</i></code> is any other atom, it is
1300             supposed to be
1301             a <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_f.htm#function_designator">function
1302               designator</a> for a unary function which will be called to
1303             convert the string to something else.
1304           </p>
1305           <p xmlns="http://www.w3.org/1999/xhtml">
1306             Those were the rules for <em>simple</em> parameter types, but
1307             <code xmlns=""><i>parameter-type</i></code> can also be a list starting
1308             with one of the symbols
1309             <code>LIST</code>, <code>ARRAY</code>,
1310             or <code>HASH-TABLE</code>.  The second value of the list must
1311             always be a simple parameter type as in the last paragraph -
1312             we'll call it the <em>inner type</em> below.
1313           </p>
1314           <p xmlns="http://www.w3.org/1999/xhtml">
1315             In the case of <code>'LIST</code>, all GET/POST parameters
1316             called <code xmlns=""><i>real-name</i></code> will be collected,
1317             converted to the inner type as by the rules above, and
1318             assembled into a list which will be the value of
1319             <code xmlns=""><i>var</i></code>.
1320           </p>
1321           <p xmlns="http://www.w3.org/1999/xhtml">
1322             In the case of <code>'ARRAY</code>, all GET/POST parameters
1323             which have a name like the result of
1324           </p>
1325           <pre xmlns="http://www.w3.org/1999/xhtml">(format nil "~A[~A]" real-name n)</pre>
1326           where <code><i>n</i></code> is a non-negative integer, will be
1327           assembled into an array where the <code><i>n</i></code>th element
1328           will be set accordingly, after conversion to the inner type.
1329           The array, which will become the value
1330           of <code><i>var</i></code>, will be big enough to hold all
1331           matching parameters, but not bigger.  Array elements not set as
1332           described above will be <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.  Note
1333           that <code xmlns="http://www.w3.org/1999/xhtml">VAR</code> will always be bound to an array, which
1334           may be empty, so it will never be <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>, even if no
1335           appropriate GET/POST parameters are found.
1336           <p xmlns="http://www.w3.org/1999/xhtml">
1337             The full form of a <code>'HASH-TABLE</code> parameter type is
1338           </p>
1339           <pre xmlns="http://www.w3.org/1999/xhtml">(hash-table inner-type key-type test-function)</pre>
1340           but <code><i>key-type</i></code>
1341           and <code><i>test-function</i></code> can be left out in which
1342           case they default to <code xmlns="http://www.w3.org/1999/xhtml">'STRING</code>
1343           and <code xmlns="http://www.w3.org/1999/xhtml">'EQUAL</code>, respectively.  For this parameter type,
1344           all GET/POST parameters which have a name like the result of
1345           <pre xmlns="http://www.w3.org/1999/xhtml">(format nil "~A{~A}" real-name key)</pre>
1346           (where <code><i>key</i></code> is a string that doesn't contain
1347           curly brackets) will become the values (after conversion
1348           to <code><i>inner-type</i></code>) of a hash table with test
1349           function <code><i>test-function</i></code>
1350           where <code><i>key</i></code> (after conversion
1351           to <code><i>key-type</i></code>) will be the corresponding key.
1352           Note that <code><i>var</i></code> will always be bound to a hash
1353           table, which may be empty, so it will never be <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>,
1354           even if no appropriate GET/POST parameters are found.
1355           <p xmlns="http://www.w3.org/1999/xhtml">
1356             To make matters even more complicated, the three compound
1357             parameter types also have an abbreviated form - just one of
1358             the symbols <code>LIST</code>, <code>ARRAY</code>,
1359             or <code>HASH-TABLE</code>.  In this case, the inner type will
1360             default to <code>'STRING</code>.
1361           </p>
1362           <p xmlns="http://www.w3.org/1999/xhtml">
1363             If <code xmlns=""><i>parameter-type</i></code> is not provided
1364             or <code>NIL</code>, <code xmlns=""><i>default-parameter-type</i></code>
1365             (the default of which is <code>'STRING</code>) will be used
1366             instead.
1367           </p>
1368           <p xmlns="http://www.w3.org/1999/xhtml">
1369             If the result of the computations above would be
1370             that <code xmlns=""><i>var</i></code> would be bound
1371             to <code>NIL</code>, then <code xmlns=""><i>init-form</i></code> (if
1372             provided) will be evaluated instead,
1373             and <code xmlns=""><i>var</i></code> will be bound to the result of this
1374             evaluation.
1375           </p>
1376           <p xmlns="http://www.w3.org/1999/xhtml">
1377             Handlers built with this macro are constructed in such a way
1378             that the resulting Lisp function is useful even outside of
1379             Hunchentoot.  Specifically, all the parameter computations
1380             above will only happen if <code xmlns=""><a href="#*request*">*REQUEST*</a></code> is
1381             bound, i.e. if we're within a Hunchentoot request.
1382             Otherwise, <code xmlns=""><i>var</i></code> will always be bound to the
1383             result of evaluating <code xmlns=""><i>init-form</i></code> unless a
1384             corresponding keyword argument is provided.
1385           </p>
1386           <p xmlns="http://www.w3.org/1999/xhtml">
1387             The <a href="#example">example code</a> that comes with
1388             Hunchentoot contains an example which demonstrates some of the
1389             features of <code xmlns=""><a href="#define-easy-handler">DEFINE-EASY-HANDLER</a></code>.
1390           </p>
1391         </clix:description></blockquote></p>
1392
1393       <p xmlns=""><a class="none" name="dispatch-easy-handlers"></a>
1394           [Function]
1395           <br><b>dispatch-easy-handlers</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
1396         </clix:lambda-list></i>
1397             =&gt;
1398             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
1399         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">This is a dispatcher which returns the appropriate handler
1400         defined with <code><a href="#define-easy-handler">DEFINE-EASY-HANDLER</a></code>, if there is one.
1401         </clix:description></blockquote></p>
1402
1403
1404
1405     <h4 xmlns=""><a name="requests">Request objects</a></h4>
1406
1407       For each incoming request, the <a href="#acceptors">acceptor</a> (in
1408       <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code>) creates a
1409       <code xmlns=""><a href="#request">REQUEST</a></code> object and makes it available to <a href="#request-dispatch">handlers</a> via the special variable
1410       <code xmlns=""><a href="#*request*">*REQUEST*</a></code>.  This object contains all relevant
1411       information about the request and this section collects the functions
1412       which can be used to query such an object.  In all function where
1413       <code xmlns=""><i>request</i></code> is an optional or keyword parameter, the
1414       default is <code xmlns=""><a href="#*request*">*REQUEST*</a></code>.
1415
1416       <p>
1417         If you need more fine-grained control over the behaviour of request
1418         objects, you can subclass <code xmlns=""><a href="#request">REQUEST</a></code> and initialize
1419         the <a href="#acceptor-request-class"><code>REQUEST-CLASS</code></a>
1420         slot of the <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> class accordingly.  The
1421         acceptor will generate request objects of the class named by this
1422         slot.
1423       </p>
1424
1425       <p xmlns=""><a class="none" name="request"></a>
1426       [Standard class]
1427       <br><b>request</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1428           Objects of this class hold all the information
1429           about an incoming request.  They are created automatically by
1430           acceptors and can be accessed by the
1431           corresponding <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>.
1432
1433           You should not mess with the slots of these objects directly, but you
1434           can subclass <code><a href="#request">REQUEST</a></code> in order to implement your
1435           own behaviour.  See
1436           the <a xmlns="http://www.w3.org/1999/xhtml" href="#acceptor-request-class"><code>REQUEST-CLASS</code></a>
1437           slot of the <code><a href="#acceptor">ACCEPTOR</a></code> class.
1438         </clix:description></blockquote></p>
1439
1440       <p xmlns=""><a class="none" name="*request*"></a>
1441       [Special variable]
1442       <br><b>*request*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">The current REQUEST object while in the context of a request.
1443         </clix:description></blockquote></p>
1444
1445       <p xmlns=""><a class="none" name="real-remote-addr"></a>
1446           [Function]
1447           <br><b>real-remote-addr</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1448           <tt>&amp;optional
1449           </tt> request
1450         </clix:lambda-list></i>
1451             =&gt;
1452             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string{, list}
1453         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1454           Returns the '<code xmlns="http://www.w3.org/1999/xhtml">X-Forwarded-For</code>' incoming http header as the
1455           second value in the form of a list of IP addresses and the first
1456           element of this list as the first value if this header exists.
1457           Otherwise returns the value of <code><a href="#remote-addr">REMOTE-ADDR</a></code> as the only value.
1458         </clix:description></blockquote></p>
1459
1460       <p xmlns=""><a class="none" name="parameter"></a>
1461           [Function]
1462           <br><b>parameter</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
1463         <tt>&amp;optional
1464         </tt> request
1465         </clix:lambda-list></i>
1466             =&gt;
1467             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
1468         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1469           Returns the GET or the POST parameter with name
1470           <code><i>name</i></code> (a string) - or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>
1471           if there is none.  If both a GET and a POST parameter with
1472           the same name exist the GET parameter is returned.  Search
1473           is case-sensitive.  See also
1474           <code><a href="#get-parameter">GET-PARAMETER</a></code> and
1475           <code><a href="#post-parameter">POST-PARAMETER</a></code>.
1476         </clix:description></blockquote></p>
1477
1478       <p xmlns=""><a class="none" name="get-parameter"></a>
1479           [Function]
1480           <br><b>get-parameter</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name <tt>&amp;optional</tt> request</clix:lambda-list></i>
1481             =&gt;
1482             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1483           Returns the value of the GET parameter (as provided via the
1484           request URI) named by the string <code><i>name</i></code> as a
1485           string (or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> if there ain't no GET parameter
1486           with this name). Note that only the first value will be
1487           returned if the client provided more than one GET parameter
1488           with the name <code><i>name</i></code>. See
1489           also <code><a href="#get-parameters*">GET-PARAMETERS*</a></code>.
1490         </clix:description></blockquote></p>
1491
1492       <p xmlns=""><a class="none" name="post-parameter"></a>
1493           [Function]
1494           <br><b>post-parameter</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name <tt>&amp;optional</tt> request</clix:lambda-list></i>
1495             =&gt;
1496             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1497           Returns the value of the POST parameter (as provided in the
1498           request's body) named by the
1499           string <code><i>name</i></code>. Note that only the first value
1500           will be returned if the client provided more than one POST
1501           parameter with the name <code><i>name</i></code>.  This value
1502           will usually be a string (or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> if there ain't
1503           no POST parameter with this name). If, however, the browser
1504           sent a <a xmlns="http://www.w3.org/1999/xhtml" class="none" name="upload">file</a> through
1505           a <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc2388.html">
1506             <code>multipart/form-data</code>
1507           </a> form, the value of this function is a three-element list
1508           <pre xmlns="http://www.w3.org/1999/xhtml">(path file-name content-type)</pre>
1509           where <code><i>path</i></code> is a pathname denoting the place
1510           were the uploaded file was
1511           stored, <code><i>file-name</i></code> (a string) is the file
1512           name sent by the browser, and <code><i>content-type</i></code>
1513           (also a string) is the content type sent by the browser. The
1514           file denoted by <code><i>path</i></code> will be deleted after
1515           the request has been handled - you have to move or copy it
1516           somewhere else if you want to keep it.
1517           <p xmlns="http://www.w3.org/1999/xhtml">
1518             POST parameters will only be computed if the content type of
1519             the request body was <code>multipart/form-data</code>
1520             or <code>application/x-www-form-urlencoded</code>.  Although
1521             this function is called <code>POST-PARAMETER</code>, you can
1522             instruct Hunchentoot to compute these parameters for other
1523             request methods by
1524             setting <code xmlns=""><a href="#*methods-for-post-parameters*">*METHODS-FOR-POST-PARAMETERS*</a></code>.
1525           </p>
1526           <p xmlns="http://www.w3.org/1999/xhtml">
1527             See also <code xmlns=""><a href="#post-parameters">POST-PARAMETERS</a></code>
1528             and <code xmlns=""><a href="#*tmp-directory*">*TMP-DIRECTORY*</a></code>.
1529           </p>
1530         </clix:description></blockquote></p>
1531
1532       <p xmlns=""><a class="none" name="get-parameters*"></a>
1533           [Function]
1534           <br><b>get-parameters*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc"><tt>&amp;optional</tt> request</clix:lambda-list></i>
1535             =&gt;
1536             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1537           Returns
1538           an <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist">alist</a>
1539           of all GET parameters (as provided via the request
1540           URI). The <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_c.htm#car">car</a>
1541           of each element of this list is the parameter's name while
1542           the <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_c.htm#cdr">cdr</a>
1543           is its value (as a string). The elements of this list are in
1544           the same order as they were within the request URI. See
1545           also <code><a href="#get-parameter">GET-PARAMETER</a></code>.
1546         </clix:description></blockquote></p>
1547
1548       <p xmlns=""><a class="none" name="post-parameters*"></a>
1549           [Function]
1550           <br><b>post-parameters*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc"><tt>&amp;optional</tt> request</clix:lambda-list></i>
1551             =&gt;
1552             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1553           Returns
1554           an <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist">alist</a>
1555           of all POST parameters (as provided via the request's
1556           body). The <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_c.htm#car">car</a>
1557           of each element of this list is the parameter's name while
1558           the <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_c.htm#cdr">cdr</a>
1559           is its value. The elements of this list are in the same order
1560           as they were within the request's body.
1561           <p xmlns="http://www.w3.org/1999/xhtml">
1562             See also <code xmlns=""><a href="#post-parameter">POST-PARAMETER</a></code>.
1563           </p>
1564         </clix:description></blockquote></p>
1565
1566       <p xmlns=""><a class="none" name="*methods-for-post-parameters*"></a>
1567       [Special variable]
1568       <br><b>*methods-for-post-parameters*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">A list of the request method types (as keywords) for which
1569         Hunchentoot will try to compute <code><i>post-parameters</i></code>.
1570         </clix:description></blockquote></p>
1571
1572       <p xmlns=""><a class="none" name="cookie-in"></a>
1573           [Function]
1574           <br><b>cookie-in</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
1575         <tt>&amp;optional
1576         </tt> request
1577         </clix:lambda-list></i>
1578             =&gt;
1579             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
1580         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1581           Returns the cookie with the name <code><i>name</i></code> (a string) as sent by the
1582           browser - or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> if there is none.
1583         </clix:description></blockquote></p>
1584
1585       <p xmlns=""><a class="none" name="cookies-in*"></a>
1586           [Function]
1587           <br><b>cookies-in*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1588           <tt>&amp;optional
1589           </tt> request
1590         </clix:lambda-list></i>
1591             =&gt;
1592             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist
1593         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Returns an alist of all cookies associated with the <code><a href="#request">REQUEST</a></code> object
1594         <code><i>request</i></code>.
1595         </clix:description></blockquote></p>
1596
1597       <p xmlns=""><a class="none" name="host"></a>
1598           [Function]
1599           <br><b>host</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1600           <tt>&amp;optional
1601           </tt> request
1602         </clix:lambda-list></i>
1603             =&gt;
1604             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">host
1605         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Returns the 'Host' incoming http header value.
1606         </clix:description></blockquote></p>
1607
1608       <p xmlns=""><a class="none" name="query-string*"></a>
1609           [Function]
1610           <br><b>query-string*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1611           <tt>&amp;optional
1612           </tt> request
1613         </clix:lambda-list></i>
1614             =&gt;
1615             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
1616         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1617           Returns the query string of the <code><a href="#request">REQUEST</a></code> object <code><i>request</i></code>. That's
1618           the part behind the question mark (i.e. the GET parameters).
1619         </clix:description></blockquote></p>
1620
1621       <p xmlns=""><a class="none" name="referer"></a>
1622           [Function]
1623           <br><b>referer</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1624           <tt>&amp;optional
1625           </tt> request
1626         </clix:lambda-list></i>
1627             =&gt;
1628             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
1629         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1630           Returns the 'Referer' (sic!) http header.
1631         </clix:description></blockquote></p>
1632
1633       <p xmlns=""><a class="none" name="request-method*"></a>
1634           [Function]
1635           <br><b>request-method*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1636           <tt>&amp;optional
1637           </tt> request
1638         </clix:lambda-list></i>
1639             =&gt;
1640             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">keyword
1641         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1642           Returns the request method as a Lisp keyword.
1643         </clix:description></blockquote></p>
1644
1645       <p xmlns=""><a class="none" name="request-uri*"></a>
1646           [Function]
1647           <br><b>request-uri*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1648           <tt>&amp;optional
1649           </tt> request
1650         </clix:lambda-list></i>
1651             =&gt;
1652             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">uri
1653         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1654           Returns the request URI.
1655         </clix:description></blockquote></p>
1656
1657       <p xmlns=""><a class="none" name="server-protocol*"></a>
1658           [Function]
1659           <br><b>server-protocol*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1660           <tt>&amp;optional
1661           </tt> request
1662         </clix:lambda-list></i>
1663             =&gt;
1664             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">keyword
1665         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1666           Returns the request protocol as a Lisp keyword.
1667         </clix:description></blockquote></p>
1668
1669       <p xmlns=""><a class="none" name="user-agent"></a>
1670           [Function]
1671           <br><b>user-agent</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1672           <tt>&amp;optional
1673           </tt> request
1674         </clix:lambda-list></i>
1675             =&gt;
1676             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
1677         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1678           Returns the 'User-Agent' http header.
1679         </clix:description></blockquote></p>
1680
1681       <p xmlns=""><a class="none" name="header-in*"></a>
1682           [Function]
1683           <br><b>header-in*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
1684         <tt>&amp;optional
1685         </tt> request
1686         </clix:lambda-list></i>
1687             =&gt;
1688             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">header
1689         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1690           Returns the incoming header with name
1691           <code><i>name</i></code>.  <code><i>name</i></code> can be
1692           a keyword (recommended) or a string.
1693         </clix:description></blockquote></p>
1694
1695       <p xmlns=""><a class="none" name="headers-in*"></a>
1696           [Function]
1697           <br><b>headers-in*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1698           <tt>&amp;optional
1699           </tt> request
1700         </clix:lambda-list></i>
1701             =&gt;
1702             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist
1703         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1704           Returns an alist of the incoming headers associated with the
1705           <code><a href="#request">REQUEST</a></code> object
1706           <code><i>request</i></code>.
1707         </clix:description></blockquote></p>
1708
1709       <p xmlns=""><a class="none" name="remote-addr*"></a>
1710           [Function]
1711           <br><b>remote-addr*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1712           <tt>&amp;optional
1713           </tt> request
1714         </clix:lambda-list></i>
1715             =&gt;
1716             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">address
1717         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1718           Returns the address the current request originated from.
1719         </clix:description></blockquote></p>
1720
1721       <p xmlns=""><a class="none" name="remote-port*"></a>
1722           [Function]
1723           <br><b>remote-port*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1724           <tt>&amp;optional
1725           </tt> request
1726         </clix:lambda-list></i>
1727             =&gt;
1728             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">port
1729         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1730           Returns the port the current request originated from.
1731         </clix:description></blockquote></p>
1732
1733       <p xmlns=""><a class="none" name="local-addr*"></a>
1734           [Function]
1735           <br><b>local-addr*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1736           <tt>&amp;optional
1737           </tt> request
1738         </clix:lambda-list></i>
1739             =&gt;
1740             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">address
1741         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1742           The IP address of the local system that the client connected to.
1743         </clix:description></blockquote></p>
1744
1745       <p xmlns=""><a class="none" name="local-port*"></a>
1746           [Function]
1747           <br><b>local-port*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1748           <tt>&amp;optional
1749           </tt> request
1750         </clix:lambda-list></i>
1751             =&gt;
1752             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">port
1753         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1754           The TCP port number of the local system that the client connected to.
1755         </clix:description></blockquote></p>
1756
1757       <p xmlns=""><a class="none" name="script-name*"></a>
1758           [Function]
1759           <br><b>script-name*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1760           <tt>&amp;optional
1761           </tt> request
1762         </clix:lambda-list></i>
1763             =&gt;
1764             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">script-name
1765         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1766           Returns the file name of the <code><a href="#request">REQUEST</a></code>
1767           object <code><i>request</i></code>. That's the
1768           requested URI without the query string (i.e the GET
1769           parameters).
1770         </clix:description></blockquote></p>
1771
1772       <p xmlns=""><a class="none" name="aux-request-value"></a>
1773       [Accessor]
1774       <br><b>aux-request-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
1775         <tt>&amp;optional
1776         </tt> request
1777         </clix:lambda-list></i>
1778       =&gt;
1779       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">value, present-p
1780         </clix:returns></i><br><tt>(setf (</tt><b>aux-request-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
1781         <tt>&amp;optional
1782         </tt> request
1783         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1784           This accessor can be used to associate arbitrary
1785           data with the the symbol <code><i>symbol</i></code> in the <code><a href="#request">REQUEST</a></code> object
1786           <code><i>request</i></code>. <code><i>present-p</i></code> is true if such data was found, otherwise <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.
1787         </clix:description></blockquote></p>
1788
1789       <p xmlns=""><a class="none" name="delete-aux-request-value"></a>
1790           [Function]
1791           <br><b>delete-aux-request-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
1792         <tt>&amp;optional
1793         </tt> request
1794         </clix:lambda-list></i>
1795             =&gt;
1796             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
1797         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1798           Removes the value associated with <code><i>symbol</i></code> from the <code><a href="#request">REQUEST</a></code> object
1799           <code><i>request</i></code>.
1800         </clix:description></blockquote></p>
1801
1802       <p xmlns=""><a class="none" name="authorization"></a>
1803           [Function]
1804           <br><b>authorization</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1805           <tt>&amp;optional
1806           </tt> request
1807         </clix:lambda-list></i>
1808             =&gt;
1809             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
1810         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1811           Returns as two values the user and password (if any) as
1812           encoded in the 'AUTHORIZATION' header.  Returns
1813           <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> if there is no such header.
1814         </clix:description></blockquote></p>
1815
1816       <p xmlns=""><a class="none" name="*hunchentoot-default-external-format*"></a>
1817       [Special variable]
1818       <br><b>*hunchentoot-default-external-format*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1819           The external format used to compute the <code><a href="#request">REQUEST</a></code> object.
1820         </clix:description></blockquote></p>
1821
1822       <p xmlns=""><a class="none" name="*file-upload-hook*"></a>
1823       [Special variable]
1824       <br><b>*file-upload-hook*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1825           If this is not <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>, it should be a unary
1826           function which will be called with a pathname for each file
1827           which is <a xmlns="http://www.w3.org/1999/xhtml" href="#upload">uploaded</a> to Hunchentoot.  The
1828           pathname denotes the temporary file to which the uploaded
1829           file is written.  The hook is called directly before the
1830           file is created. At this point,
1831           <code><a href="#*request*">*REQUEST*</a></code> is already bound to the
1832           current <code><a href="#request">REQUEST</a></code> object, but obviously
1833           you can't access the post parameters yet.
1834         </clix:description></blockquote></p>
1835
1836       <p xmlns=""><a class="none" name="raw-post-data"></a>
1837           [Function]
1838           <br><b>raw-post-data</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1839           <tt>&amp;key</tt>
1840           request external-format force-text force-binary want-stream
1841         </clix:lambda-list></i>
1842             =&gt;
1843             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">raw-body-or-stream</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1844           Returns the content sent by the client in the request body if
1845           there was any (unless the content type
1846           was <code xmlns="http://www.w3.org/1999/xhtml">multipart/form-data</code> in which
1847           case <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> is returned).  By default, the result is
1848           a string if the type of the <code xmlns="http://www.w3.org/1999/xhtml">Content-Type</code>
1849           <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc1590.html">media type</a>
1850           is <code xmlns="http://www.w3.org/1999/xhtml">"text"</code>, and a vector of octets otherwise.  In
1851           the case of a string, the external format to be used to decode
1852           the content will be determined from the <code xmlns="http://www.w3.org/1999/xhtml">charset</code>
1853           parameter sent by the client (or
1854           otherwise <code><a href="#*hunchentoot-default-external-format*">*HUNCHENTOOT-DEFAULT-EXTERNAL-FORMAT*</a></code>
1855           will be used).
1856           <p xmlns="http://www.w3.org/1999/xhtml">
1857             You can also provide an external format explicitly (through
1858             <code xmlns=""><i>external-format</i></code>) in which case the result
1859             will unconditionally be a string.  Likewise, you can provide
1860             a true value for <code xmlns=""><i>force-text</i></code> which will
1861             force Hunchentoot to act as if the type of the media type
1862             had been <code>"text"</code>
1863             (with <code xmlns=""><i>external-format</i></code> taking precedence
1864             if provided).  Or you can provide a true value
1865             for <code xmlns=""><i>force-binary</i></code> which means that you
1866             want a vector of octets at any rate.  (If both
1867             <code xmlns=""><i>force-text</i></code>
1868             and <code xmlns=""><i>force-binary</i></code> are true, an error will
1869             be signaled.)
1870           </p>
1871           <p xmlns="http://www.w3.org/1999/xhtml">
1872             If, however, you provide a true value
1873             for <code xmlns=""><i>want-stream</i></code>, the other parameters are
1874             ignored and you'll get the content (flexi) stream to read
1875             from it yourself.  It is then your responsibility to read
1876             the correct amount of data, because otherwise you won't be
1877             able to return a response to the client.  The stream will
1878             have
1879             its <a href="http://weitz.de/flexi-streams/#flexi-streams">octet
1880               position</a> set to <code>0</code>.  If the client provided
1881             a <code>Content-Length</code> header, the stream will also
1882             have a
1883             corresponding <a href="http://weitz.de/flexi-streams/#flexi-streams">bound</a>,
1884             so no matter whether the client used chunked encoding or
1885             not, you can always read until EOF.
1886           </p>
1887           <p xmlns="http://www.w3.org/1999/xhtml">
1888             If the content type of the request
1889             was <code>multipart/form-data</code>
1890             or <code>application/x-www-form-urlencoded</code>, the
1891             content has been read by Hunchentoot already and you can't
1892             read from the stream anymore.
1893           </p>
1894           <p xmlns="http://www.w3.org/1999/xhtml">
1895             You can call <code xmlns=""><a href="#raw-post-data">RAW-POST-DATA</a></code> more than once
1896             per request, but you can't mix calls which have different
1897             values for <code xmlns=""><i>want-stream</i></code>.
1898           </p>
1899           <p xmlns="http://www.w3.org/1999/xhtml">
1900             Note that this function is slightly misnamed because a
1901             client can send content even if the request method is not
1902             POST.
1903           </p>
1904         </clix:description></blockquote></p>
1905
1906
1907       <p xmlns=""><a class="none" name="recompute-request-parameters"></a>
1908           [Function]
1909           <br><b>recompute-request-parameters</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
1910           <tt>&amp;key
1911           </tt> request external-format
1912         </clix:lambda-list></i>
1913             =&gt;
1914             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
1915         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1916           Recomputes the GET and POST parameters for the <code><a href="#request">REQUEST</a></code> object
1917           <code><i>request</i></code>.  This only makes sense if you're switching external formats
1918           during the request.
1919         </clix:description></blockquote></p>
1920
1921       <p xmlns=""><a class="none" name="process-request"></a>
1922           [Generic function]
1923           <br><b>process-request</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
1924         </clix:lambda-list></i>
1925             =&gt;
1926             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">nil
1927         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1928           This function is called by <code><a href="#process-connection">PROCESS-CONNECTION</a></code>
1929           after the incoming headers have been read.  It
1930           calls <code><a href="#handle-request">HANDLE-REQUEST</a></code> (and is more or less just a
1931           thin wrapper around it) to select and call a
1932           <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a> and send the output of this handler to
1933           the client.  Note that <code><a href="#process-connection">PROCESS-CONNECTION</a></code> is
1934           called once per connection and loops in case of a persistent
1935           connection while <code><a href="#process-request">PROCESS-REQUEST</a></code> is called anew
1936           for each request.
1937           <p xmlns="http://www.w3.org/1999/xhtml">
1938             The return value of this function is ignored.
1939           </p>
1940           <p xmlns="http://www.w3.org/1999/xhtml">
1941             Like <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code>, this is another function
1942             the behaviour of which you should only modify if you really, really
1943             know what you're doing.
1944           </p>
1945         </clix:description></blockquote></p>
1946
1947       <p xmlns=""><a class="none" name="handle-request"></a>
1948           [Generic function]
1949           <br><b>handle-request</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor request
1950         </clix:lambda-list></i>
1951             =&gt;
1952             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content
1953         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1954           This function is called by <code><a href="#process-request">PROCESS-REQUEST</a></code> once
1955           the request has been read and a <code><a href="#request">REQUEST</a></code> object
1956           has been created.  Its job is to actually handle the request, i.e. to
1957           return something to the client.
1958           <p xmlns="http://www.w3.org/1999/xhtml">
1959             The default method calls the
1960             acceptor's <a href="#request-dispatch">request dispatcher</a>, but you
1961             can of course implement a different behaviour.  The default method
1962             also sets up <a href="#logging">standard error handling</a> for
1963             the <a href="#request-dispatch">handler</a>.
1964           </p>
1965           <p xmlns="http://www.w3.org/1999/xhtml">
1966             Might be a good place to bind or rebind special variables which can
1967             then be accessed by your <a href="#request-dispatch">handlers</a>.
1968           </p>
1969         </clix:description></blockquote></p>
1970
1971       <p xmlns=""><a class="none" name="acceptor-dispatch-request"></a>
1972           [Generic function]
1973           <br><b>acceptor-dispatch-request</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor request
1974         </clix:lambda-list></i>
1975             =&gt;
1976             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content
1977         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
1978           This function is called to actually dispatch the request
1979           once the standard logging and error handling has been set
1980           up.  <code><a href="#acceptor">ACCEPTOR</a></code> subclasses implement
1981           methods for this function in order to perform their own
1982           request routing.  If a method does not want to handle the
1983           request, it is supposed to invoke <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/f_call_n.htm">CALL-NEXT-METHOD</a>
1984           so that the next <code><a href="#acceptor">ACCEPTOR</a></code> in the
1985           inheritance chain gets a chance to handle the request.
1986         </clix:description></blockquote></p>
1987
1988       <p xmlns="">
1989       [Generic readers]<br><a class="none" name="cookies-in"></a><b>cookies-in</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
1990           </clix:lambda-list></i>
1991         =&gt;
1992         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">cookies
1993           </clix:returns></i><br><a class="none" name="get-parameters"></a><b>get-parameters</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
1994           </clix:lambda-list></i>
1995         =&gt;
1996         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">get-parameters
1997           </clix:returns></i><br><a class="none" name="header-in"></a><b>header-in</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name request
1998           </clix:lambda-list></i>
1999         =&gt;
2000         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2001           </clix:returns></i><br><a class="none" name="headers-in"></a><b>headers-in</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2002           </clix:lambda-list></i>
2003         =&gt;
2004         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">headers
2005           </clix:returns></i><br><a class="none" name="post-parameters"></a><b>post-parameters</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2006           </clix:lambda-list></i>
2007         =&gt;
2008         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">post-parameters
2009           </clix:returns></i><br><a class="none" name="query-string"></a><b>query-string</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2010           </clix:lambda-list></i>
2011         =&gt;
2012         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">query-string
2013           </clix:returns></i><br><a class="none" name="remote-addr"></a><b>remote-addr</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2014           </clix:lambda-list></i>
2015         =&gt;
2016         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">address
2017           </clix:returns></i><br><a class="none" name="remote-port"></a><b>remote-port</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2018           </clix:lambda-list></i>
2019         =&gt;
2020         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">port
2021           </clix:returns></i><br><a class="none" name="local-addr"></a><b>local-addr</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2022           </clix:lambda-list></i>
2023         =&gt;
2024         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">address
2025           </clix:returns></i><br><a class="none" name="local-port"></a><b>local-port</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2026           </clix:lambda-list></i>
2027         =&gt;
2028         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">port
2029           </clix:returns></i><br><a class="none" name="request-acceptor"></a><b>request-acceptor</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2030           </clix:lambda-list></i>
2031         =&gt;
2032         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">acceptor
2033           </clix:returns></i><br><a class="none" name="request-method"></a><b>request-method</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2034           </clix:lambda-list></i>
2035         =&gt;
2036         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">method
2037           </clix:returns></i><br><a class="none" name="request-uri"></a><b>request-uri</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2038           </clix:lambda-list></i>
2039         =&gt;
2040         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">uri
2041           </clix:returns></i><br><a class="none" name="server-protocol"></a><b>server-protocol</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2042           </clix:lambda-list></i>
2043         =&gt;
2044         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">protocol
2045           </clix:returns></i><br><a class="none" name="script-name"></a><b>script-name</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2046           </clix:lambda-list></i>
2047         =&gt;
2048         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2049           </clix:returns></i><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2050           These are various generic readers which are used
2051           to read information about a <code><a href="#request">REQUEST</a></code> object.  If you are writing a
2052           <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>, you should <em xmlns="http://www.w3.org/1999/xhtml">not</em> use these readers but instead utilize the
2053           corresponding functions with an asterisk at the end of their name,
2054           also listed in this section.  These generic readers are only
2055           exported for users who want to create their own subclasses of
2056           <code><a href="#request">REQUEST</a></code>.
2057         </clix:description></blockquote></p>
2058
2059
2060
2061     <h4 xmlns=""><a name="replies">Reply objects</a></h4>
2062
2063       For each incoming request, the <a href="#acceptors">acceptor</a>
2064       (in <code xmlns=""><a href="#process-connection">PROCESS-CONNECTION</a></code>) creates
2065       a <code xmlns=""><a href="#reply">REPLY</a></code> object and makes it available
2066       to <a href="#request-dispatch">handlers</a> via the special variable
2067       <code xmlns=""><a href="#*reply*">*REPLY*</a></code>.  This object contains all relevant
2068       information (except for the content body) about the reply that will be
2069       sent to the client and this section collects the functions which can
2070       be used to query and modify such an object.  In all function
2071       where <code xmlns=""><i>reply</i></code> is an optional or keyword parameter,
2072       the default is <code xmlns=""><a href="#*reply*">*REPLY*</a></code>.
2073
2074       <p>
2075         If you need more fine-grained control over the behaviour of reply
2076         objects, you can subclass <code xmlns=""><a href="#reply">REPLY</a></code> and initialize
2077         the <a href="#acceptor-reply-class"><code>REPLY-CLASS</code></a>
2078         slot of the <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> class accordingly.  The
2079         acceptor will generate reply objects of the class named by this
2080         slot.
2081       </p>
2082
2083       <p xmlns=""><a class="none" name="reply"></a>
2084       [Standard class]
2085       <br><b>reply</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2086           Objects of this class hold all the information about an
2087           outgoing reply.  They are created automatically by
2088           Hunchentoot and can be accessed and modified by the
2089           corresponding <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>.
2090         <p xmlns="http://www.w3.org/1999/xhtml">
2091           You should not mess with the slots of these objects directly, but you
2092           can subclass <code xmlns=""><a href="#reply">REPLY</a></code> in order to implement your own behaviour.  See the
2093           <a href="#acceptor-reply-class"><code>:reply-class</code></a> initarg
2094           of the <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> class.
2095         </p>
2096         </clix:description></blockquote></p>
2097
2098       <p xmlns=""><a class="none" name="*reply*"></a>
2099       [Special variable]
2100       <br><b>*reply*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2101           The current <code><a href="#reply">REPLY</a></code> object in the context of a request.
2102         </clix:description></blockquote></p>
2103
2104       <p xmlns=""><a class="none" name="header-out"></a>
2105       [Accessor]
2106       <br><b>header-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
2107         <tt>&amp;optional
2108         </tt> reply
2109         </clix:lambda-list></i>
2110       =&gt;
2111       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
2112         </clix:returns></i><br><tt>(setf (</tt><b>header-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
2113         <tt>&amp;optional
2114         </tt> reply
2115         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2116           <code><a href="#header-out">HEADER-OUT</a></code> returns the outgoing http
2117           header named by the keyword <code><i>name</i></code> if
2118           there is one, otherwise <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>. <code xmlns="http://www.w3.org/1999/xhtml">SETF</code>
2119           of <code><a href="#header-out">HEADER-OUT</a></code> changes the current value
2120           of the header named <code><i>name</i></code>. If no header
2121           named <code><i>name</i></code> exists, it is created. For
2122           backwards compatibility, <code><i>name</i></code> can also
2123           be a string in which case the association between a header
2124           and its name is case-insensitive.
2125           <p xmlns="http://www.w3.org/1999/xhtml">
2126             Note that the header 'Set-Cookie' cannot be queried by
2127             <code xmlns=""><a href="#header-out">HEADER-OUT</a></code> and must not be set by
2128             <code>SETF</code> of <code xmlns=""><a href="#header-out">HEADER-OUT</a></code>.  See
2129             also <code xmlns=""><a href="#headers-out*">HEADERS-OUT*</a></code>,
2130             <code xmlns=""><a href="#content-type*">CONTENT-TYPE*</a></code>,
2131             <code xmlns=""><a href="#content-length*">CONTENT-LENGTH*</a></code>,
2132             <code xmlns=""><a href="#cookies-out*">COOKIES-OUT*</a></code>, and
2133             <code xmlns=""><a href="#cookie-out">COOKIE-OUT</a></code>.
2134           </p>
2135         </clix:description></blockquote></p>
2136
2137       <p xmlns=""><a class="none" name="headers-out*"></a>
2138           [Function]
2139           <br><b>headers-out*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2140           <tt>&amp;optional
2141           </tt> reply
2142         </clix:lambda-list></i>
2143             =&gt;
2144             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist
2145         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Returns an alist of the outgoing headers associated with the
2146         <code><a href="#reply">REPLY</a></code> object <code><i>reply</i></code>.  See also <code><a href="#header-out">HEADER-OUT</a></code>.
2147         </clix:description></blockquote></p>
2148
2149       <p xmlns=""><a class="none" name="content-length*"></a>
2150       [Accessor]
2151       <br><b>content-length*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2152           <tt>&amp;optional
2153           </tt> reply
2154         </clix:lambda-list></i>
2155       =&gt;
2156       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content-length
2157         </clix:returns></i><br><tt>(setf (</tt><b>content-length*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2158           <tt>&amp;optional
2159           </tt> reply
2160         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2161           The outgoing 'Content-Length' http header of <code><i>reply</i></code>.
2162         </clix:description></blockquote></p>
2163
2164       <p xmlns=""><a class="none" name="content-type*"></a>
2165       [Accessor]
2166       <br><b>content-type*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2167           <tt>&amp;optional
2168           </tt> reply
2169         </clix:lambda-list></i>
2170       =&gt;
2171       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content-type
2172         </clix:returns></i><br><tt>(setf (</tt><b>content-type*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2173           <tt>&amp;optional
2174           </tt> reply
2175         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2176           The outgoing 'Content-Type' http header of <code><i>reply</i></code>.
2177         </clix:description></blockquote></p>
2178
2179       <p xmlns=""><a class="none" name="cookie-out"></a>
2180           [Function]
2181           <br><b>cookie-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">name
2182         <tt>&amp;optional
2183         </tt> reply
2184         </clix:lambda-list></i>
2185             =&gt;
2186             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2187         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2188           Returns the current value of the outgoing <a xmlns="http://www.w3.org/1999/xhtml" href="#cookies">cookie</a> named
2189           <code><i>name</i></code>. Search is case-sensitive.
2190         </clix:description></blockquote></p>
2191
2192       <p xmlns=""><a class="none" name="cookies-out*"></a>
2193       [Accessor]
2194       <br><b>cookies-out*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2195           <tt>&amp;optional
2196           </tt> reply
2197         </clix:lambda-list></i>
2198       =&gt;
2199       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">alist
2200         </clix:returns></i><br><tt>(setf (</tt><b>cookies-out*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2201           <tt>&amp;optional
2202           </tt> reply
2203         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2204           Returns or sets an alist of the outgoing <a xmlns="http://www.w3.org/1999/xhtml" href="#cookies">cookies</a> associated with the
2205           <code><a href="#reply">REPLY</a></code> object
2206           <code><i>reply</i></code>.
2207         </clix:description></blockquote></p>
2208
2209       <p xmlns=""><a class="none" name="return-code*"></a>
2210       [Accessor]
2211       <br><b>return-code*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2212           <tt>&amp;optional
2213           </tt> reply
2214         </clix:lambda-list></i>
2215       =&gt;
2216       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">return-code
2217         </clix:returns></i><br><tt>(setf (</tt><b>return-code*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2218           <tt>&amp;optional
2219           </tt> reply
2220         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2221           Gets or sets the http return code of
2222           <code><i>reply</i></code>.  The return code of each
2223           <code><a href="#reply">REPLY</a></code> object is initially set to
2224           <code><a href="#+http-ok+">+HTTP-OK+</a></code>.
2225         </clix:description></blockquote></p>
2226
2227       <p xmlns=""><a class="none" name="send-headers"></a>
2228           [Function]
2229           <br><b>send-headers</b> <i></i>
2230             =&gt;
2231             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">stream</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2232           Sends the initial status line and all headers as determined
2233           by the <code><a href="#reply">REPLY</a></code>
2234           object <code><a href="#*reply*">*REPLY*</a></code>.  Returns
2235           a <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_b.htm#binary">binary</a>
2236           stream to which the body of the reply can be written.  Once
2237           this function has been called, further changes
2238           to <code><a href="#*reply*">*REPLY*</a></code> don't have any effect.
2239           Also, automatic handling of errors (i.e. sending the
2240           corresponding status code to the browser, etc.) is turned
2241           off for this request and functions
2242           like <code><a href="#redirect">REDIRECT</a></code> or
2243           to <code><a href="#abort-request-handler">ABORT-REQUEST-HANDLER</a></code> won't have the
2244           desired effect once the headers are sent.
2245           <p xmlns="http://www.w3.org/1999/xhtml">
2246             If your handlers return the full body as a string or as an
2247             array of octets, you should <em>not</em> call this function.
2248             If a handler calls <code xmlns=""><a href="#send-headers">SEND-HEADERS</a></code> , its
2249             return value is ignored.
2250           </p>
2251         </clix:description></blockquote></p>
2252
2253       <p xmlns=""><a class="none" name="reply-external-format*"></a>
2254       [Accessor]
2255       <br><b>reply-external-format*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2256           <tt>&amp;optional
2257           </tt> reply
2258         </clix:lambda-list></i>
2259       =&gt;
2260       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">external-format
2261         </clix:returns></i><br><tt>(setf (</tt><b>reply-external-format*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2262           <tt>&amp;optional
2263           </tt> reply
2264         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2265           Gets or sets the external format of <code><i>reply</i></code> which is used for character output.
2266         </clix:description></blockquote></p>
2267
2268       <p xmlns=""><a class="none" name="*default-content-type*"></a>
2269       [Special variable]
2270       <br><b>*default-content-type*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2271           The default content-type header which is returned to the client.
2272         </clix:description></blockquote></p>
2273
2274       <p xmlns="">
2275       [Constants]<br><b>+http-continue+</b><br><b>+http-switching-protocols+</b><br><b>+http-ok+</b><br><b>+http-created+</b><br><b>+http-accepted+</b><br><b>+http-non-authoritative-information+</b><br><b>+http-no-content+</b><br><b>+http-reset-content+</b><br><b>+http-partial-content+</b><br><b>+http-multi-status+</b><br><b>+http-multiple-choices+</b><br><b>+http-moved-permanently+</b><br><b>+http-moved-temporarily+</b><br><b>+http-see-other+</b><br><b>+http-not-modified+</b><br><b>+http-use-proxy+</b><br><b>+http-temporary-redirect+</b><br><b>+http-bad-request+</b><br><b>+http-authorization-required+</b><br><b>+http-payment-required+</b><br><b>+http-forbidden+</b><br><b>+http-not-found+</b><br><b>+http-method-not-allowed+</b><br><b>+http-not-acceptable+</b><br><b>+http-proxy-authentication-required+</b><br><b>+http-request-time-out+</b><br><b>+http-conflict+</b><br><b>+http-gone+</b><br><b>+http-length-required+</b><br><b>+http-precondition-failed+</b><br><b>+http-request-entity-too-large+</b><br><b>+http-request-uri-too-large+</b><br><b>+http-unsupported-media-type+</b><br><b>+http-requested-range-not-satisfiable+</b><br><b>+http-expectation-failed+</b><br><b>+http-failed-dependency+</b><br><b>+http-internal-server-error+</b><br><b>+http-not-implemented+</b><br><b>+http-bad-gateway+</b><br><b>+http-service-unavailable+</b><br><b>+http-gateway-time-out+</b><br><b>+http-version-not-supported+</b><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2276           The values of these constants are 100, 101, 200, 201, 202,
2277           203, 204, 205, 206, 207, 300, 301, 302, 303, 304, 305, 307,
2278           400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411,
2279           412, 413, 414, 415, 416, 417, 424, 500, 501, 502, 503, 504,
2280           and 505. See <code><a href="#return-code">RETURN-CODE</a></code>.
2281         </clix:description></blockquote></p>
2282
2283       <p xmlns="">
2284       [Generic readers]<br><a class="none" name="content-length"></a><b>content-length</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2285           </clix:lambda-list></i>
2286         =&gt;
2287         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content-length
2288           </clix:returns></i><br><a class="none" name="content-type"></a><b>content-type</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2289           </clix:lambda-list></i>
2290         =&gt;
2291         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">content-type
2292           </clix:returns></i><br><a class="none" name="headers-out"></a><b>headers-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2293           </clix:lambda-list></i>
2294         =&gt;
2295         <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">headers-out
2296           </clix:returns></i><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2297           These are various generic readers which are used
2298           to read information about a <code><a href="#reply">REPLY</a></code> object.  If you are writing a
2299           <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>, you should <em xmlns="http://www.w3.org/1999/xhtml">not</em> use these readers but instead utilize the
2300           corresponding functions with an asterisk at the end of their name,
2301           also listed in this section.  These generic readers are only
2302           exported for users who want to create their own subclasses of
2303           <code><a href="#reply">REPLY</a></code>.
2304         </clix:description></blockquote></p>
2305
2306       <p xmlns="">
2307       [Generic accessors]<br><a class="none" name="cookies-out"></a><b>cookies-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2308           </clix:lambda-list></i>
2309       =&gt;
2310       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2311           </clix:returns></i><br><tt>(setf (</tt><b>cookies-out</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2312           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="return-code"></a><b>return-code</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2313           </clix:lambda-list></i>
2314       =&gt;
2315       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2316           </clix:returns></i><br><tt>(setf (</tt><b>return-code</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2317           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><a class="none" name="reply-external-format"></a><b>reply-external-format</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2318           </clix:lambda-list></i>
2319       =&gt;
2320       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2321           </clix:returns></i><br><tt>(setf (</tt><b>reply-external-format</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">reply
2322           </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><br><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2323           These are various generic accessors which are
2324           used to query and modify a <code><a href="#reply">REPLY</a></code> objects.  If
2325           you are writing a
2326           <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>, you should <em xmlns="http://www.w3.org/1999/xhtml">not</em> use these
2327           accessors but instead utilize the corresponding functions with an
2328           asterisk at the end of their name, also listed in this section.
2329           These generic accessors are only exported for users who want to
2330           create their own subclasses of
2331           <code><a href="#reply">REPLY</a></code>.
2332         </clix:description></blockquote></p>
2333
2334
2335
2336
2337     <h4 xmlns=""><a name="sessions">Sessions</a></h4>
2338       Hunchentoot supports <em>sessions</em>: Once a <a href="#request-dispatch">request
2339       handler</a> has called <code xmlns=""><a href="#start-session">START-SESSION</a></code>, Hunchentoot
2340       uses either cookies or (if the client doesn't send the cookies
2341       back) <a href="#*rewrite-for-session-urls*">rewrites URLs</a> to keep
2342       track of this client, i.e. to provide a kind of 'state' for the
2343       stateless http protocol. The session associated with the client is a
2344       <a href="#session">CLOS object</a> which can be used
2345       to <a href="#session-value">store arbitrary data</a> between requests.
2346       <p>
2347         Hunchentoot makes some reasonable effort to prevent eavesdroppers from
2348         hijacking sessions (see below), but this should not be considered
2349         really secure. Don't store sensitive data in sessions and rely solely
2350         on the session mechanism as a safeguard against malicious users who
2351         want to get at this data!
2352       </p>
2353       <p>
2354         For each request there's one <code xmlns=""><a href="#session">SESSION</a></code> object which is accessible to the
2355         <a href="#handler">handler</a> via the special
2356         variable <code xmlns=""><a href="#*session*">*SESSION*</a></code>. This object holds all the
2357         information available about the session and can be accessed with the
2358         functions described in this chapter. Note that the internal structure
2359         of <code xmlns=""><a href="#session">SESSION</a></code> objects should be considered opaque
2360         and may change in future releases of Hunchentoot.
2361       </p>
2362       <p>
2363         Sessions are automatically <a href="#session-verify">verified</a> for
2364         validity and age when the <code xmlns=""><a href="#request">REQUEST</a></code> object is
2365         instantiated, i.e. if <code xmlns=""><a href="#*session*">*SESSION*</a></code> is not NIL then
2366         this session is valid (as far as Hunchentoot is concerned) and
2367         not <a href="#session-too-old-p">too old</a>.  Old sessions
2368         are <a href="#session-gc">automatically removed</a>.
2369       </p>
2370       <p>
2371         Hunchentoot also provides a <code xmlns=""><a href="#session-regenerate-cookie-value">SESSION-REGENERATE-COOKIE-VALUE</a></code>
2372         function that creates a new cookie value. This helps to prevent against
2373         <a href="https://www.owasp.org/index.php/Session_fixation">session fixation
2374         attacks</a>, and should be used when a user logs in according to the application.
2375       </p>
2376
2377       <p xmlns=""><a class="none" name="session"></a>
2378       [Standard class]
2379       <br><b>session</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2380           <code><a href="#session">SESSION</a></code> objects are
2381           automatically maintained by Hunchentoot.  They should not be created
2382           explicitly with <code xmlns="http://www.w3.org/1999/xhtml">MAKE-INSTANCE</code> but implicitly
2383           with <code><a href="#start-session">START-SESSION</a></code> and they should be treated as
2384           opaque objects.
2385           <p xmlns="http://www.w3.org/1999/xhtml">
2386             You can ignore Hunchentoot's <code xmlns=""><a href="#session">SESSION</a></code> objects and
2387             <a href="#session-behaviour">implement your own sessions</a> if you provide corresponding methods for
2388             <code xmlns=""><a href="#session-cookie-value">SESSION-COOKIE-VALUE</a></code>
2389             and <code xmlns=""><a href="#session-verify">SESSION-VERIFY</a></code>.
2390           </p>
2391         </clix:description></blockquote></p>
2392
2393       <p xmlns=""><a class="none" name="start-session"></a>
2394           [Function]
2395           <br><b>start-session</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2396         </clix:lambda-list></i>
2397             =&gt;
2398             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">session
2399         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2400           Returns the current <code><a href="#session">SESSION</a></code>
2401           object. If there is no current session, creates one and updates the
2402           corresponding data structures. In this case the function will also
2403           send a session cookie to the browser.
2404         </clix:description></blockquote></p>
2405
2406       <p xmlns=""><a class="none" name="session-value"></a>
2407       [Accessor]
2408       <br><b>session-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
2409         <tt>&amp;optional
2410         </tt> session
2411         </clix:lambda-list></i>
2412       =&gt;
2413       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">value, present-p
2414         </clix:returns></i><br><tt>(setf (</tt><b>session-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
2415         <tt>&amp;optional
2416         </tt> session
2417         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2418           This accessor can be used to associate arbitrary data with the the
2419           symbol <code><i>symbol</i></code> in the <code><a href="#session">SESSION</a></code>
2420           object <code><i>session</i></code>. <code><i>present-p</i></code> is
2421           true if such data was found, otherwise <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>. The default
2422           value for <code><i>session</i></code> is
2423           <code><a href="#*session*">*SESSION*</a></code>.
2424           <p xmlns="http://www.w3.org/1999/xhtml">
2425             If <code>SETF</code> of <code xmlns=""><a href="#session-value">SESSION-VALUE</a></code> is called
2426             with <code xmlns=""><i>session</i></code> being <code>NIL</code> then a
2427             session is automatically instantiated
2428             with <code xmlns=""><a href="#start-session">START-SESSION</a></code>.
2429           </p>
2430         </clix:description></blockquote></p>
2431
2432       <p xmlns=""><a class="none" name="delete-session-value"></a>
2433           [Function]
2434           <br><b>delete-session-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">symbol
2435         <tt>&amp;optional
2436         </tt> session
2437         </clix:lambda-list></i>
2438             =&gt;
2439             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
2440         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2441           Removes the value associated with
2442           <code><i>symbol</i></code> from
2443           <code><i>session</i></code> if there is one.
2444         </clix:description></blockquote></p>
2445
2446       <p xmlns=""><a class="none" name="*session*"></a>
2447       [Special variable]
2448       <br><b>*session*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2449           The current session while in the context of a request, or
2450           <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.
2451         </clix:description></blockquote></p>
2452
2453       <p xmlns=""><a class="none" name="remove-session"></a>
2454           [Function]
2455           <br><b>remove-session</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2456         </clix:lambda-list></i>
2457             =&gt;
2458             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
2459         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2460           Completely removes the <code><a href="#session">SESSION</a></code> object
2461           <code><i>session</i></code> from Hunchentoot's
2462           internal <a xmlns="http://www.w3.org/1999/xhtml" href="#session-db">session database</a>.
2463         </clix:description></blockquote></p>
2464
2465       <p xmlns=""><a class="none" name="reset-sessions"></a>
2466           [Function]
2467           <br><b>reset-sessions</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2468           <tt>&amp;optional
2469           </tt> acceptor
2470         </clix:lambda-list></i>
2471             =&gt;
2472             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
2473         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2474           Removes <em xmlns="http://www.w3.org/1999/xhtml">all</em> stored sessions of
2475           <code><i>acceptor</i></code>.  The default for
2476           <code><i>acceptor</i></code> is
2477           <code><a href="#*acceptor*">*ACCEPTOR*</a></code>.
2478         </clix:description></blockquote></p>
2479
2480       <p xmlns=""><a class="none" name="regenerate-session-cookie-value"></a>
2481           [Function]
2482           <br><b>regenerate-session-cookie-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2483         </clix:lambda-list></i>
2484             =&gt;
2485             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">cookie
2486         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2487           Regenerates the session cookie value. This should be used
2488           when a user logs in according to the application to prevent
2489           against session fixation attacks. The cookie value being
2490           dependent on ID, USER-AGENT, REMOTE-ADDR, START, and
2491           *SESSION-SECRET*, the only value we can change is START to
2492           regenerate a new value. Since we're generating a new cookie,
2493           it makes sense to have the session being restarted, in
2494           time. That said, because of this fact, calling this function
2495           twice in the same second will regenerate twice the same
2496           value.
2497         </clix:description></blockquote></p>
2498
2499       <p xmlns=""><a class="none" name="*rewrite-for-session-urls*"></a>
2500       [Special variable]
2501       <br><b>*rewrite-for-session-urls*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2502           Whether HTML pages should possibly be rewritten for cookie-less
2503           session-management.
2504         </clix:description></blockquote></p>
2505
2506       <p xmlns=""><a class="none" name="*content-types-for-url-rewrite*"></a>
2507       [Special variable]
2508       <br><b>*content-types-for-url-rewrite*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2509           The content types for which url-rewriting is OK. See
2510           <code><a href="#*rewrite-for-session-urls*">*REWRITE-FOR-SESSION-URLS*</a></code>.
2511         </clix:description></blockquote></p>
2512
2513       <p xmlns=""><a class="none" name="*use-remote-addr-for-sessions*"></a>
2514       [Special variable]
2515       <br><b>*use-remote-addr-for-sessions*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2516           Whether the client's remote IP (as returned by <code><a href="#real-remote-addr">REAL-REMOTE-ADDR</a></code>)
2517           should be encoded into the session string.  If this value is true, a
2518           session will cease to be accessible if the client's remote IP changes.
2519           <p xmlns="http://www.w3.org/1999/xhtml">
2520             This might for example be an issue if the client uses a proxy server
2521             which doesn't send correct 'X-Forwarded-For' headers.
2522           </p>
2523         </clix:description></blockquote></p>
2524
2525       <p xmlns=""><a class="none" name="session-remote-addr"></a>
2526           [Generic function]
2527           <br><b>session-remote-addr</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2528         </clix:lambda-list></i>
2529             =&gt;
2530             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">remote-addr
2531         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2532           The remote IP address of the client when this session was started (as
2533           returned by <code><a href="#real-remote-addr">REAL-REMOTE-ADDR</a></code>).
2534         </clix:description></blockquote></p>
2535
2536       <p xmlns=""><a class="none" name="*use-user-agent-for-sessions*"></a>
2537       [Special variable]
2538       <br><b>*use-user-agent-for-sessions*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">Whether the 'User-Agent' header should
2539         be encoded into the session string.  If this value is true, a session
2540         will cease to be accessible if the client sends a different
2541         'User-Agent' header.
2542         </clix:description></blockquote></p>
2543
2544       <p xmlns=""><a class="none" name="session-user-agent"></a>
2545           [Generic function]
2546           <br><b>session-user-agent</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2547         </clix:lambda-list></i>
2548             =&gt;
2549             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">user-agent
2550         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2551           The incoming 'User-Agent' header that
2552           was sent when this session was created.
2553         </clix:description></blockquote></p>
2554
2555       <p xmlns=""><a class="none" name="session-max-time"></a>
2556       [Generic accessor]
2557       <br><b>session-max-time</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2558         </clix:lambda-list></i>
2559       =&gt;
2560       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">max-time
2561         </clix:returns></i><br><tt>(setf (</tt><b>session-max-time</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2562         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2563           Gets or sets the time (in seconds) after
2564           which <code><i>session</i></code> expires if it's not used.
2565         </clix:description></blockquote></p>
2566
2567
2568       <p xmlns=""><a class="none" name="*session-max-time*"></a>
2569       [Special variable]
2570       <br><b>*session-max-time*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2571           The default time (in seconds) after which a session times out.
2572         </clix:description></blockquote></p>
2573
2574       <p xmlns=""><a class="none" name="*session-gc-frequency*"></a>
2575       [Special variable]
2576       <br><b>*session-gc-frequency*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2577           A session GC (see function <code><a href="#session-gc">SESSION-GC</a></code>) will happen every
2578           <code><a href="#*session-gc-frequency*">*SESSION-GC-FREQUENCY*</a></code> requests (counting only
2579           requests which create a new session) if this variable is
2580           not <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.  See <code><a href="#session-created">SESSION-CREATED</a></code>.
2581         </clix:description></blockquote></p>
2582
2583       <p xmlns=""><a class="none" name="session-gc"></a>
2584           [Function]
2585           <br><b>session-gc</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2586         </clix:lambda-list></i>
2587             =&gt;
2588             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
2589         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2590           Removes sessions from the current session database which are
2591           too old - see <code><a href="#session-too-old-p">SESSION-TOO-OLD-P</a></code>.
2592         </clix:description></blockquote></p>
2593
2594       <p xmlns=""><a class="none" name="session-too-old-p"></a>
2595           [Function]
2596           <br><b>session-too-old-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2597         </clix:lambda-list></i>
2598             =&gt;
2599             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">generalized-boolean
2600         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2601           Returns true if the <code><a href="#session">SESSION</a></code> object <code><i>session</i></code> has not been active in
2602           the last <code xmlns="http://www.w3.org/1999/xhtml">(session-max-time session)</code> seconds.
2603         </clix:description></blockquote></p>
2604
2605       <p xmlns=""><a class="none" name="session-id"></a>
2606           [Generic function]
2607           <br><b>session-id</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2608         </clix:lambda-list></i>
2609             =&gt;
2610             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">session-id
2611         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2612           The unique ID (an INTEGER) of the session.
2613         </clix:description></blockquote></p>
2614
2615       <p xmlns=""><a class="none" name="session-start"></a>
2616           [Generic function]
2617           <br><b>session-start</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2618         </clix:lambda-list></i>
2619             =&gt;
2620             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">universal-time
2621         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2622           The time this session was started.
2623         </clix:description></blockquote></p>
2624
2625
2626
2627     <h4 xmlns=""><a name="session-behaviour">Customizing session behaviour</a></h4>
2628
2629       For everyday session usage, you will probably just
2630       use <code xmlns=""><a href="#start-session">START-SESSION</a></code>,
2631       <code xmlns=""><a href="#session-value">SESSION-VALUE</a></code>,
2632       and maybe <code xmlns=""><a href="#delete-session-value">DELETE-SESSION-VALUE</a></code>
2633       and <code xmlns=""><a href="#*session*">*SESSION*</a></code>.  However, there are two ways to
2634       customize the way Hunchentoot maintains sessions.
2635       <p>
2636         One way is to mostly leave the session mechanism intact but to tweak
2637         it a bit:
2638         <ul>
2639           <li>The publicly visible part of a session is encoded using a
2640           <a href="#*session-secret*">secret</a> which you can set yourself.</li>
2641           <li>And it is stored using a cookie (or GET
2642           parameter) <a href="#session-cookie-name">name</a> that you can
2643           override.</li>
2644           <li>Each session receives a <a href="#next-session-id">new ID</a> when
2645           it is created and you can implement a more robust way to do that.</li>
2646           <li>You can arrange to be called whenever a session
2647           is <a href="#session-created">created</a> to trigger some action.  You
2648           might also do this to invent your own
2649           session <a href="#session-gc">garbage collection</a>.</li>
2650           <li>By default, all sessions are stored in a global alist in memory.
2651           You can't change the alist part, but you can distribute your sessions
2652           over different <a href="#session-db">"databases"</a>.</li>
2653           <li>By default, every operation which modifies sessions or one of the
2654           session databases is guarded by a global lock, but you can arrange to
2655           <a href="#session-db-lock">provide</a> different locks for this.</li>
2656         </ul>
2657       </p>
2658       <p>
2659         The other way to customize Hunchentoot's sessions is to completely
2660         replace them.  This is actually pretty easy: Create your own class to
2661         store state (which doesn't have to and probably shouldn't inherit
2662         from <code xmlns=""><a href="#session">SESSION</a></code>) and implement methods for
2663         <code xmlns=""><a href="#session-verify">SESSION-VERIFY</a></code>
2664         and <code xmlns=""><a href="#session-cookie-value">SESSION-COOKIE-VALUE</a></code> - that's it.
2665         Hunchentoot will continue to use cookies and/or to rewrite URLs to
2666         keep track of session state and it will store "the current session"
2667         (whatever that is in your implementation)
2668         in <code xmlns=""><a href="#*session*">*SESSION*</a></code>.  Everything else (like persisting
2669         sessions, GC, getting and setting values) you'll have to take care of
2670         yourself and the other session functions
2671         (like <code xmlns=""><a href="#start-session">START-SESSION</a></code> or
2672         <code xmlns=""><a href="#session-value">SESSION-VALUE</a></code>) won't work anymore.  (Almost)
2673         total freedom, but a lot of responsibility as well... :)
2674       </p>
2675
2676       <p xmlns=""><a class="none" name="*session-secret*"></a>
2677       [Special variable]
2678       <br><b>*session-secret*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2679           A random ASCII string that's used to encode the public
2680           session data.  This variable is initially unbound and will
2681           be set (using <code><a href="#reset-session-secret">RESET-SESSION-SECRET</a></code>) the
2682           first time a session is created, if necessary.  You can
2683           prevent this from happening if you set the value yourself
2684           before starting <a xmlns="http://www.w3.org/1999/xhtml" href="#acceptors">acceptors</a>.
2685         </clix:description></blockquote></p>
2686
2687       <p xmlns=""><a class="none" name="reset-session-secret"></a>
2688           [Function]
2689           <br><b>reset-session-secret</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2690         </clix:lambda-list></i>
2691             =&gt;
2692             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">secret
2693         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2694           Sets <code><a href="#*session-secret*">*SESSION-SECRET*</a></code> to a
2695           new random value. All old sessions will cease to be valid.
2696         </clix:description></blockquote></p>
2697
2698       <p xmlns=""><a class="none" name="session-cookie-name"></a>
2699           [Generic function]
2700           <br><b>session-cookie-name</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
2701         </clix:lambda-list></i>
2702             =&gt;
2703             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">name
2704         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2705           Returns the name (a string) of the cookie (or
2706           the GET parameter) which is used to store a session on the client
2707           side.  The default is to use the
2708           string <code xmlns="http://www.w3.org/1999/xhtml">"hunchentoot-session"</code>, but you can
2709           specialize this function if you want another name.
2710         </clix:description></blockquote></p>
2711
2712       <p xmlns=""><a class="none" name="session-created"></a>
2713           [Generic function]
2714           <br><b>session-created</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor new-session
2715         </clix:lambda-list></i>
2716             =&gt;
2717             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2718         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2719           This function is called whenever a new session
2720           has been created.  There's a default method which might trigger
2721           a <a xmlns="http://www.w3.org/1999/xhtml" href="#session-gc">session GC</a> based on the value of
2722           <code><a href="#*session-gc-frequency*">*SESSION-GC-FREQUENCY*</a></code>.
2723           <p xmlns="http://www.w3.org/1999/xhtml">
2724             The return value is ignored.
2725           </p>
2726         </clix:description></blockquote></p>
2727
2728       <p xmlns=""><a class="none" name="next-session-id"></a>
2729           [Generic function]
2730           <br><b>next-session-id</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
2731         </clix:lambda-list></i>
2732             =&gt;
2733             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">id
2734         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2735           Returns the next sequential session ID, an
2736           integer, which should be unique per session.  The default method uses
2737           a simple global counter and isn't guarded by a lock.  For a
2738           high-performance production environment you might consider using a
2739           more robust implementation.
2740         </clix:description></blockquote></p>
2741
2742       <p xmlns=""><a class="none" name="session-db"></a>
2743       [Generic accessor]
2744       <br><b>session-db</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
2745         </clix:lambda-list></i>
2746       =&gt;
2747       <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">database
2748         </clix:returns></i><br><tt>(setf (</tt><b>session-db</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
2749         </clix:lambda-list></i><tt>) <i>new-value</i>)</tt><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2750           Returns the current session database which is an
2751           alist where each car is a session's ID and the cdr is the
2752           corresponding <code><a href="#session">SESSION</a></code> object itself.  The default
2753           is to use a global list for all acceptors.
2754         </clix:description></blockquote></p>
2755
2756       <p xmlns=""><a class="none" name="session-db-lock"></a>
2757           [Generic function]
2758           <br><b>session-db-lock</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">acceptor
2759         <tt>&amp;key
2760         </tt> whole-db-p
2761         </clix:lambda-list></i>
2762             =&gt;
2763             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">lock
2764         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2765           A function which returns a lock that will be
2766           used to prevent concurrent access to sessions.  The first argument
2767           will be the <a xmlns="http://www.w3.org/1999/xhtml" href="#acceptors">acceptor</a> that handles the
2768           current <a xmlns="http://www.w3.org/1999/xhtml" href="#requests">request</a>, the second argument is true
2769           if the whole (current) session database is modified.  If it
2770           is <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>, only one existing session in the database is
2771           modified.
2772           <p xmlns="http://www.w3.org/1999/xhtml">
2773             This function can return <code>NIL</code> which means that sessions or
2774             session databases will be modified without a lock held (for example
2775             for single-threaded environments).  The default is to always return a
2776             global lock (ignoring the <code xmlns=""><i>acceptor</i></code> argument) for
2777             Lisps that support threads and <code>NIL</code> otherwise.
2778           </p>
2779         </clix:description></blockquote></p>
2780
2781       <p xmlns=""><a class="none" name="session-verify"></a>
2782           [Generic function]
2783           <br><b>session-verify</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">request
2784         </clix:lambda-list></i>
2785             =&gt;
2786             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">session-or-nil
2787         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2788           Tries to get a session identifier from the cookies
2789           (or alternatively from the GET parameters) sent by the client (see
2790           <code><a href="#session-cookie-name">SESSION-COOKIE-NAME</a></code>
2791           and <code><a href="#session-cookie-value">SESSION-COOKIE-VALUE</a></code>).  This identifier is
2792           then checked for validity against the <code><a href="#request">REQUEST</a></code>
2793           object
2794           <code><i>request</i></code>.  On success the corresponding session object (if not too
2795           old) is returned (and updated).  Otherwise <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> is returned.
2796           <p xmlns="http://www.w3.org/1999/xhtml">
2797             A default method is provided and you only need to write your own one
2798             if you want to maintain your own sessions.
2799           </p>
2800         </clix:description></blockquote></p>
2801
2802       <p xmlns=""><a class="none" name="session-cookie-value"></a>
2803           [Generic function]
2804           <br><b>session-cookie-value</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">session
2805         </clix:lambda-list></i>
2806             =&gt;
2807             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
2808         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2809           Returns a string which can be used to safely
2810           restore the session <code><i>session</i></code> if as session has
2811           already been established.  This is used as the value stored in the
2812           session cookie or in the corresponding GET parameter and verified
2813           by <code><a href="#session-verify">SESSION-VERIFY</a></code>.
2814           <p xmlns="http://www.w3.org/1999/xhtml">
2815             A default
2816             method is provided and there's no reason to change it unless you
2817             want to use your own session objects.
2818           </p>
2819         </clix:description></blockquote></p>
2820
2821
2822
2823     <h4 xmlns=""><a name="cookies">Cookies</a></h4>
2824
2825       Outgoing cookies are stored in the request's <code xmlns=""><a href="#reply">REPLY</a></code>
2826       object (see <code xmlns=""><a href="#cookie-out">COOKIE-OUT</a></code>
2827       and <code xmlns=""><a href="#cookies-out*">COOKIES-OUT*</a></code>). They are CLOS objects
2828       defined like this:
2829
2830       <pre>(defclass cookie ()
2831   ((name :initarg :name
2832          :reader <a class="noborder" name="cookie-name">cookie-name</a>
2833          :type string
2834          :documentation "The name of the cookie - a string.")
2835    (value :initarg :value
2836           :accessor <a class="noborder" name="cookie-value">cookie-value</a>
2837           :initform ""
2838           :documentation "The value of the cookie. Will be URL-encoded when sent to the browser.")
2839    (expires :initarg :expires
2840             :initform nil
2841             :accessor <a class="noborder" name="cookie-expires">cookie-expires</a>
2842             :documentation "The time (a universal time) when the cookie expires (or NIL).")
2843    (max-age :initarg :max-age
2844             :initform nil
2845             :accessor <a class="noborder" name="cookie-max-age">cookie-max-age</a>
2846             :documentation "The time delta (in seconds) after which the cookie expires (or NIL).")
2847    (path :initarg :path
2848          :initform nil
2849          :accessor <a class="noborder" name="cookie-path">cookie-path</a>
2850          :documentation "The path this cookie is valid for (or NIL).")
2851    (domain :initarg :domain
2852            :initform nil
2853            :accessor <a class="noborder" name="cookie-domain">cookie-domain</a>
2854            :documentation "The domain this cookie is valid for (or NIL).")
2855    (secure :initarg :secure
2856            :initform nil
2857            :accessor <a class="noborder" name="cookie-secure">cookie-secure</a>
2858            :documentation "A generalized boolean denoting whether this is a secure cookie.")
2859    (http-only :initarg :http-only
2860               :initform nil
2861               :accessor <a class="noborder" name="cookie-http-only">cookie-http-only</a>
2862               :documentation "A generalized boolean denoting whether this is a <a href="http://msdn2.microsoft.com/en-us/library/ms533046.aspx">HttpOnly</a> cookie.")))
2863       </pre>
2864
2865       The <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_r.htm#reader">reader</a>
2866       <code xmlns=""><a href="#cookie-name">COOKIE-NAME</a></code> and
2867       the <a href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#accessor">accessors</a>
2868       <code xmlns=""><a href="#cookie-value">COOKIE-VALUE</a></code>, <code xmlns=""><a href="#cookie-expires">COOKIE-EXPIRES</a></code>, <code xmlns=""><a href="#cookie-max-age">COOKIE-MAX-AGE</a></code>,
2869       <code xmlns=""><a href="#cookie-path">COOKIE-PATH</a></code>, <code xmlns=""><a href="#cookie-domain">COOKIE-DOMAIN</a></code>, <code xmlns=""><a href="#cookie-secure">COOKIE-SECURE</a></code>,
2870       and <code xmlns=""><a href="#cookie-http-only">COOKIE-HTTP-ONLY</a></code> are all exported from
2871       the <code>HUNCHENTOOT</code> package.  For now, the class name itself is <em>not</em> exported.
2872
2873       <p xmlns=""><a class="none" name="set-cookie"></a>
2874           [Function]
2875           <br><b>set-cookie</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
2876           name <tt>&amp;key</tt> value expires path
2877           domain secure http-only reply
2878         </clix:lambda-list></i>
2879             =&gt;
2880             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">cookie</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2881           Creates a <code xmlns="http://www.w3.org/1999/xhtml">COOKIE</code> object from the parameters
2882           provided to this function and adds it to the outgoing cookies
2883           of the <a xmlns="http://www.w3.org/1999/xhtml" href="#replies"><code>REPLY</code> object</a>
2884           <code><i>reply</i></code>. If a cookie with the same name
2885           (case-sensitive) already exists, it is replaced. The default
2886           for <code><i>reply</i></code>
2887           is <code><a href="#*reply*">*REPLY*</a></code>. The default
2888           for <code><i>value</i></code> is the empty string.
2889         </clix:description></blockquote></p>
2890
2891       <p xmlns=""><a class="none" name="set-cookie*"></a>
2892           [Function]
2893           <br><b>set-cookie*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">cookie <tt>&amp;optional</tt> reply</clix:lambda-list></i>
2894             =&gt;
2895             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">cookie</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2896           Adds the <code xmlns="http://www.w3.org/1999/xhtml">COOKIE</code> object <code><i>cookie</i></code>
2897           to the outgoing cookies of
2898           the <a xmlns="http://www.w3.org/1999/xhtml" href="#replies"><code>REPLY</code> object</a>
2899           <code><i>reply</i></code>. If a cookie with the same name
2900           (case-sensitive) already exists, it is replaced. The default
2901           for <code><i>reply</i></code> is <code><a href="#*reply*">*REPLY*</a></code>.
2902         </clix:description></blockquote></p>
2903
2904
2905     <h4 xmlns=""><a name="logging">Logging</a></h4>
2906       Hunchentoot can log accesses and diagnostic messages to two
2907       separate destinations, which can be either files in the file
2908       system or streams.  Logging can also be disabled by setting the
2909       <clix:code xmlns:clix="http://bknr.net/clixdoc">ACCESS-LOG-DESTINATION</clix:code> and
2910       <clix:code xmlns:clix="http://bknr.net/clixdoc">MESSAGE-LOG-DESTINATION</clix:code> slots in the
2911       <code xmlns=""><a href="#acceptor">ACCEPTOR</a></code> to <code>NIL</code>.  The two
2912       slots can be initialized by providing the
2913       :ACCESS-LOG-DESTINATION and :MESSAGE-LOG-DESTINATION
2914       initialization arguments when creating the acceptor or set by
2915       setting the slots through its
2916       <code xmlns=""><a href="#acceptor-message-log-destination">ACCEPTOR-MESSAGE-LOG-DESTINATION</a></code> and
2917       <code xmlns=""><a href="#acceptor-access-log-destination">ACCEPTOR-ACCESS-LOG-DESTINATION</a></code> accessors.
2918       <p>
2919         When the path for the message or accept log is set to a
2920         variable holding an output stream, hunchentoots writes
2921         corresponding log entries to that stream.  By default,
2922         Hunchentoot logs to *STANDARD-ERROR*.
2923       </p>
2924       <p>
2925         Access logging is done in a format similar to what
2926         the Apache web server can write so that logfile analysis using
2927         standard tools is possible.  Errors during request processing are
2928         logged to a separate file.
2929       </p>
2930       <p>
2931         The standard logging mechanism is deliberately simple and slow.  The
2932         log files are opened for each log entry and closed again after
2933         writing, and access to them is protected by a global lock.  Derived
2934         acceptor classes can implement methods for the
2935         <code xmlns=""><a href="#acceptor-log-message">ACCEPTOR-LOG-MESSAGE</a></code> and
2936         <code xmlns=""><a href="#acceptor-log-access">ACCEPTOR-LOG-ACCESS</a></code> generic functions in order to
2937         log differently (e.g. to a central logging server or in a different
2938         file format.
2939       </p>
2940       <p>
2941         Errors happening within a <a href="#request-dispatch">handler</a>
2942         which are not caught by the handler itself are handled by
2943         Hunchentoot by logging them to the established
2944         <code xmlns=""><a href="#acceptor-message-log-destination">ACCEPTOR-MESSAGE-LOG-DESTINATION</a></code>.
2945       </p>
2946
2947       <p xmlns=""><a class="none" name="log-message*"></a>
2948           [Function]
2949           <br><b>log-message*</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">log-level format-string
2950         <tt>&amp;rest
2951         </tt> format-arguments
2952         </clix:lambda-list></i>
2953             =&gt;
2954             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
2955         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2956           Convenience function which calls the message
2957           logger of the current acceptor (if there is one) with the same
2958           arguments it accepts.  Returns <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> if there is no message
2959           logger or whatever the message logger returns.
2960           <p xmlns="http://www.w3.org/1999/xhtml">
2961             This is the function which Hunchentoot itself uses to log errors it
2962             catches during request processing.
2963           </p>
2964         </clix:description></blockquote></p>
2965
2966       <p xmlns=""><a class="none" name="*log-lisp-errors-p*"></a>
2967       [Special variable]
2968       <br><b>*log-lisp-errors-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2969           Whether Lisp errors in request handlers should be logged.
2970         </clix:description></blockquote></p>
2971
2972       <p xmlns=""><a class="none" name="*log-lisp-backtraces-p*"></a>
2973       [Special variable]
2974       <br><b>*log-lisp-backtraces-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2975           Whether Lisp backtraces should be logged.  Only
2976           has an effect if <code><a href="#*log-lisp-errors-p*">*LOG-LISP-ERRORS-P*</a></code> is true
2977           as well.
2978         </clix:description></blockquote></p>
2979
2980       <p xmlns=""><a class="none" name="*log-lisp-warnings-p*"></a>
2981       [Special variable]
2982       <br><b>*log-lisp-warnings-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2983           Whether Lisp warnings in request handlers should be logged.
2984         </clix:description></blockquote></p>
2985
2986       <p xmlns=""><a class="none" name="*lisp-errors-log-level*"></a>
2987       [Special variable]
2988       <br><b>*lisp-errors-log-level*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2989           Log level for Lisp errors.  Should be one
2990           of <code xmlns="http://www.w3.org/1999/xhtml">:ERROR</code> (the default), <code xmlns="http://www.w3.org/1999/xhtml">:WARNING</code>,
2991           or <code xmlns="http://www.w3.org/1999/xhtml">:INFO</code>.
2992         </clix:description></blockquote></p>
2993
2994       <p xmlns=""><a class="none" name="*lisp-warnings-log-level*"></a>
2995       [Special variable]
2996       <br><b>*lisp-warnings-log-level*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
2997           Log level for Lisp warnings.
2998           Should be one of <code xmlns="http://www.w3.org/1999/xhtml">:ERROR</code>, <code xmlns="http://www.w3.org/1999/xhtml">:WARNING</code>
2999           (the default), or <code xmlns="http://www.w3.org/1999/xhtml">:INFO</code>.
3000         </clix:description></blockquote></p>
3001
3002
3003     <h4 xmlns=""><a name="conditions">Conditions and error handling</a></h4>
3004       <p>
3005         This section describes how Hunchentoot deals with exceptional
3006         situations.  See also the secion about <a href="#logging">logging</a>.
3007       </p>
3008       <p>
3009         When an error occurs while processing a request, Hunchentoot's
3010         default behavior is to catch the error, log it and
3011         optionally display it to the client in the HTML response.
3012         This behavior can be customized through the values of a number
3013         of special variables, which are documented below.
3014       </p>
3015
3016       <p xmlns=""><a class="none" name="*catch-errors-p*"></a>
3017       [Special variable]
3018       <br><b>*catch-errors-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3019           If the value of this variable is <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>
3020           (the default is <code xmlns="http://www.w3.org/1999/xhtml">T</code>), then errors which happen while a
3021           request is handled aren't <a xmlns="http://www.w3.org/1999/xhtml" href="#logging">caught as usual</a>, but
3022           instead your
3023           Lisp's <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_d.htm#debugger">debugger</a>
3024           is <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/f_invoke.htm">invoked</a>.
3025           This variable should obviously always be set to a <em xmlns="http://www.w3.org/1999/xhtml">true</em> value
3026           in a production environment.
3027           See <code><a href="#maybe-invoke-debugger">MAYBE-INVOKE-DEBUGGER</a></code>
3028           if you want to fine-tune this behaviour.
3029         </clix:description></blockquote></p>
3030
3031       <p xmlns=""><a class="none" name="*show-lisp-errors-p*"></a>
3032       [Special variable]
3033       <br><b>*show-lisp-errors-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3034           Whether Lisp errors should be shown in HTML output.  Note
3035           that this only affects canned responses generated by Lisp.
3036           If an error template is present for the "internal server
3037           error" status code, this special variable is not used (see
3038           <code><a href="#acceptor-status-message">acceptor-status-message</a></code>).
3039         </clix:description></blockquote></p>
3040
3041       <p xmlns=""><a class="none" name="*show-lisp-backtraces-p*"></a>
3042       [Special variable]
3043       <br><b>*show-lisp-backtraces-p*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3044           Whether Lisp backtraces should be shown in HTML output if
3045           <code><a href="#*show-lisp-errors-p*">*SHOW-LISP-ERRORS-P*</a></code> is true and an error occurs.
3046         </clix:description></blockquote></p>
3047
3048       <p xmlns=""><a class="none" name="maybe-invoke-debugger"></a>
3049           [Generic function]
3050           <br><b>maybe-invoke-debugger</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">condition
3051         </clix:lambda-list></i>
3052             =&gt;
3053             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
3054         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3055           This generic function is called whenever a
3056           <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/09_.htm">condition</a> <code xmlns="http://www.w3.org/1999/xhtml"><i>condition</i></code>
3057           is signaled in Hunchentoot.  You might want to specialize it on
3058           specific condition classes for debugging purposes.  The default
3059           method <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.lispworks.com/documentation/HyperSpec/Body/f_invoke.htm">invokes
3060           the debugger</a> with <code><i>condition</i></code> if
3061           <code><a href="#*catch-errors-p*">*CATCH-ERRORS-P*</a></code> is <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.
3062         </clix:description></blockquote></p>
3063
3064       <p xmlns=""><a class="none" name="hunchentoot-condition"></a>
3065       [Condition type]
3066       <br><b>hunchentoot-condition</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3067           Superclass for all conditions related to Hunchentoot.
3068         </clix:description></blockquote></p>
3069
3070       <p xmlns=""><a class="none" name="hunchentoot-error"></a>
3071       [Condition type]
3072       <br><b>hunchentoot-error</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3073           Superclass for all errors related to Hunchentoot and a subclass of <code><a href="#hunchentoot-condition">HUNCHENTOOT-CONDITION</a></code>.
3074         </clix:description></blockquote></p>
3075
3076       <p xmlns=""><a class="none" name="parameter-error"></a>
3077       [Condition type]
3078       <br><b>parameter-error</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3079           Signalled if a function was called with incosistent or illegal parameters.  A subclass of <code><a href="#hunchentoot-error">HUNCHENTOOT-ERROR</a></code>.
3080         </clix:description></blockquote></p>
3081
3082       <p xmlns=""><a class="none" name="hunchentoot-warning"></a>
3083       [Condition type]
3084       <br><b>hunchentoot-warning</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3085           Superclass for all warnings related to Hunchentoot and a subclass of <code><a href="#hunchentoot-condition">HUNCHENTOOT-CONDITION</a></code>.
3086         </clix:description></blockquote></p>
3087
3088
3089
3090     <h4 xmlns=""><a name="misc">Miscellaneous</a></h4>
3091
3092       Various functions and variables which didn't fit into one of the
3093       other categories.
3094
3095       <p xmlns=""><a class="none" name="abort-request-handler"></a>
3096           [Function]
3097           <br><b>abort-request-handler</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
3098           <tt>&amp;optional
3099           </tt> result
3100         </clix:lambda-list></i>
3101             =&gt;
3102             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
3103         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3104           This function can be called by a request handler
3105           at any time to immediately abort handling the request.  This works as
3106           if the handler had returned <code><i>result</i></code>.  See the
3107           source code of <code><a href="#redirect">REDIRECT</a></code> for an example.
3108         </clix:description></blockquote></p>
3109
3110       <p xmlns=""><a class="none" name="handle-if-modified-since"></a>
3111           [Function]
3112           <br><b>handle-if-modified-since</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">time <tt>&amp;optional</tt> request</clix:lambda-list></i>
3113             =&gt;
3114             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3115           This function is designed to be used inside
3116           a <a xmlns="http://www.w3.org/1999/xhtml" href="#request-dispatch">handler</a>. If the client has sent an
3117           'If-Modified-Since' header
3118           (see <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc2616.html">RFC 2616</a>,
3119           section 14.25) and the time specified matches the universal
3120           time
3121           <code><i>time</i></code> then the
3122           header <code><a href="#+http-not-modified+">+HTTP-NOT-MODIFIED+</a></code> with no content
3123           is immediately returned to the client.
3124           <p xmlns="http://www.w3.org/1999/xhtml">
3125             Note that for this function to be useful you should usually
3126             send 'Last-Modified' headers back to the client. See the
3127             code
3128             of <code xmlns=""><a href="#create-static-file-dispatcher-and-handler">CREATE-STATIC-FILE-DISPATCHER-AND-HANDLER</a></code>
3129             for an example.
3130           </p>
3131         </clix:description></blockquote></p>
3132
3133       <p xmlns=""><a class="none" name="handle-static-file"></a>
3134           [Function]
3135           <br><b>handle-static-file</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">path <tt>&amp;optional</tt> content-type</clix:lambda-list></i>
3136             =&gt;
3137             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">nil</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3138           Sends the file denoted by the pathname designator
3139           <code><i>path</i></code> with content type
3140           <code><i>content-type</i></code> to the client.  Sets the
3141           necessary handlers.  In particular the function employs
3142           <code><a href="#handle-if-modified-since">HANDLE-IF-MODIFIED-SINCE</a></code>.
3143           <p xmlns="http://www.w3.org/1999/xhtml">
3144             If <code xmlns=""><i>content-type</i></code> is <code>NIL</code> the
3145             function tries to determine the correct content type from
3146             the file's suffix or falls back
3147             to <code>"application/octet-stream"</code> as a last resort.
3148           </p>
3149           <p xmlns="http://www.w3.org/1999/xhtml">
3150             Note that this function
3151             calls <code xmlns=""><a href="#send-headers">SEND-HEADERS</a></code> internally, so after
3152             you've called it, the headers are sent and the return value
3153             of your handler is ignored.
3154           </p>
3155         </clix:description></blockquote></p>
3156
3157       <p xmlns=""><a class="none" name="redirect"></a>
3158           [Function]
3159           <br><b>redirect</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">target <tt>&amp;key</tt> host port protocol add-session-id code</clix:lambda-list></i>
3160             =&gt;
3161             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3162           Sends back appropriate headers to redirect the client
3163           to <code><i>target</i></code> (a string).
3164           <p xmlns="http://www.w3.org/1999/xhtml">
3165             If <code xmlns=""><i>target</i></code> is a full URL starting with a
3166             scheme, <code xmlns=""><i>host</i></code>, <code xmlns=""><i>port</i></code>,
3167             and <code xmlns=""><i>protocol</i></code> are ignored.
3168             Otherwise, <code xmlns=""><i>target</i></code> should denote the path
3169             part of a URL, <code xmlns=""><i>protocol</i></code> must be one of
3170             the keywords <code>:HTTP</code> or <code>:HTTPS</code>, and
3171             the URL to redirect to will be constructed
3172             from <code xmlns=""><i>host</i></code>, <code xmlns=""><i>port</i></code>, <code xmlns=""><i>protocol</i></code>,
3173             and <code xmlns=""><i>target</i></code>.
3174           </p>
3175           <p xmlns="http://www.w3.org/1999/xhtml">
3176             <code xmlns=""><i>code</i></code> must be a 3xx HTTP redirection
3177             status code to send to the client.  It defaults to 302
3178             ("Found").  If <code xmlns=""><i>host</i></code> is not provided,
3179             the current host (see <code xmlns=""><a href="#host">HOST</a></code>) will be
3180             used. If <code xmlns=""><i>protocol</i></code> is the keyword
3181             <code>:HTTPS</code>, the client will be redirected to a
3182             https URL, if it's <code>:HTTP</code> it'll be sent to a
3183             http URL.  If both <code xmlns=""><i>host</i></code> and
3184             <code xmlns=""><i>protocol</i></code> aren't provided, then the
3185             value of <code xmlns=""><i>protocol</i></code> will match the
3186             current request.
3187           </p>
3188         </clix:description></blockquote></p>
3189
3190       <p xmlns=""><a class="none" name="require-authorization"></a>
3191           [Function]
3192           <br><b>require-authorization</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc"><tt>&amp;optional</tt> realm</clix:lambda-list></i>
3193             =&gt;
3194             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3195           Sends back appropriate headers to require basic HTTP
3196           authentication
3197           (see <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc2617.html">RFC 2617</a>)
3198           for the realm <code><i>realm</i></code>. The default value
3199           for <code><i>realm</i></code> is <code xmlns="http://www.w3.org/1999/xhtml">"Hunchentoot"</code>.
3200         </clix:description></blockquote></p>
3201
3202       <p xmlns=""><a class="none" name="no-cache"></a>
3203           [Function]
3204           <br><b>no-cache</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
3205         </clix:lambda-list></i>
3206             =&gt;
3207             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|
3208         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3209           Adds appropriate headers to completely prevent caching on most browsers.
3210         </clix:description></blockquote></p>
3211
3212       <p xmlns=""><a class="none" name="ssl-p"></a>
3213           [Function]
3214           <br><b>ssl-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
3215           <tt>&amp;optional
3216           </tt> acceptor
3217         </clix:lambda-list></i>
3218             =&gt;
3219             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">generalized-boolean
3220         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3221           Whether the current connection to the client is secure.  See <code><a href="#acceptor-ssl-p">ACCEPTOR-SSL-P</a></code>.
3222         </clix:description></blockquote></p>
3223
3224       <p xmlns=""><a class="none" name="reason-phrase"></a>
3225           [Function]
3226           <br><b>reason-phrase</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">return-code
3227         </clix:lambda-list></i>
3228             =&gt;
3229             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
3230         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3231           Returns a reason phrase for the HTTP return code <code><i>return-code</i></code>
3232           (which should be an integer) or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> for return codes Hunchentoot
3233           doesn't know.
3234         </clix:description></blockquote></p>
3235
3236       <p xmlns=""><a class="none" name="rfc-1123-date"></a>
3237           [Function]
3238           <br><b>rfc-1123-date</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
3239           <tt>&amp;optional
3240           </tt> time
3241         </clix:lambda-list></i>
3242             =&gt;
3243             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
3244         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3245           Generates a time string according to <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc1123.html">RFC 1123</a>.  Default is current time.
3246           This can be used to send a 'Last-Modified' header - see <code><a href="#handle-if-modified-since">HANDLE-IF-MODIFIED-SINCE</a></code>.
3247         </clix:description></blockquote></p>
3248
3249       <p xmlns=""><a class="none" name="url-encode"></a>
3250           [Function]
3251           <br><b>url-encode</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">string
3252         <tt>&amp;optional
3253         </tt> external-format
3254         </clix:lambda-list></i>
3255             =&gt;
3256             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
3257         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3258           URL-encodes a string using the external format <code><i>external-format</i></code>.  The default for <code><i>external-format</i></code> is the value of <code><a href="#*hunchentoot-default-external-format*">*HUNCHENTOOT-DEFAULT-EXTERNAL-FORMAT*</a></code>.
3259         </clix:description></blockquote></p>
3260
3261       <p xmlns=""><a class="none" name="url-decode"></a>
3262           [Function]
3263           <br><b>url-decode</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">string
3264         <tt>&amp;optional
3265         </tt> external-format
3266         </clix:lambda-list></i>
3267             =&gt;
3268             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">string
3269         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3270           Decodes a URL-encoded string which is assumed to
3271           be encoded using the external
3272           format <code><i>external-format</i></code>, i.e. this is the inverse
3273           of <code><a href="#url-encode">URL-ENCODE</a></code>. It is assumed that you'll rarely
3274           need this function, if ever. But just in case - here it is.  The
3275           default for <code><i>external-format</i></code> is the value
3276           of <code><a href="#*hunchentoot-default-external-format*">*HUNCHENTOOT-DEFAULT-EXTERNAL-FORMAT*</a></code>.
3277         </clix:description></blockquote></p>
3278
3279       <p xmlns=""><a class="none" name="escape-for-html"></a>
3280           [Function]
3281           <br><b>escape-for-html</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">string
3282         </clix:lambda-list></i>
3283             =&gt;
3284             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
3285         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3286           Escapes the characters #\&lt;, #\&gt;, #\', #\", and #\&amp; for HTML output.
3287         </clix:description></blockquote></p>
3288
3289       <p xmlns=""><a class="none" name="http-token-p"></a>
3290           [Function]
3291           <br><b>http-token-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">object</clix:lambda-list></i>
3292             =&gt;
3293             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">generalized-boolean</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3294           This function tests whether <code><i>object</i></code> is a
3295           non-empty string which is a <em xmlns="http://www.w3.org/1999/xhtml">token</em> according
3296           to <a xmlns="http://www.w3.org/1999/xhtml" href="http://www.faqs.org/rfcs/rfc2068.html">RFC
3297           2068</a> (i.e. whether it may be used for, say, cookie names).
3298         </clix:description></blockquote></p>
3299
3300       <p xmlns=""><a class="none" name="mime-type"></a>
3301           [Function]
3302           <br><b>mime-type</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">pathspec
3303         </clix:lambda-list></i>
3304             =&gt;
3305             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">result
3306         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3307           Given a pathname designator <code><i>pathspec</i></code> returns the <a xmlns="http://www.w3.org/1999/xhtml" href="http://en.wikipedia.org/wiki/Internet_media_type">MIME type</a>
3308           (as a string) corresponding to the suffix of the file denoted by
3309           <code><i>pathspec</i></code> (or <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>).
3310         </clix:description></blockquote></p>
3311
3312       <p xmlns=""><a class="none" name="within-request-p"></a>
3313           [Function]
3314           <br><b>within-request-p</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">
3315         </clix:lambda-list></i>
3316             =&gt;
3317             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">generalized-boolean
3318         </clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3319           Returns true if in the context of a request. Otherwise, <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.
3320         </clix:description></blockquote></p>
3321
3322       <p xmlns=""><a class="none" name="*tmp-directory*"></a>
3323       [Special variable]
3324       <br><b>*tmp-directory*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3325           This should be a pathname denoting a directory where temporary
3326           files can be stored. It is used for <a xmlns="http://www.w3.org/1999/xhtml" href="#upload">file
3327           uploads</a>.
3328         </clix:description></blockquote></p>
3329
3330       <p xmlns=""><a class="none" name="*header-stream*"></a>
3331       [Special variable]
3332       <br><b>*header-stream*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3333           If this variable is not <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>, it should be bound to a stream to
3334           which incoming and outgoing headers will be written for debugging
3335           purposes.
3336         </clix:description></blockquote></p>
3337
3338
3339       <p xmlns=""><a class="none" name="*cleanup-function*"></a>
3340       [Special variable]
3341       <br><b>*cleanup-function*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3342           A designator for a function without arguments which is called on a
3343           regular basis if <code><a href="#*cleanup-interval*">*CLEANUP-INTERVAL*</a></code> is not <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.  The initial value is
3344           the name of a function which invokes a garbage collection on 32-bit
3345           versions of LispWorks.
3346           <p xmlns="http://www.w3.org/1999/xhtml">
3347             This variable is only available on LispWorks.
3348           </p>
3349         </clix:description></blockquote></p>
3350
3351       <p xmlns=""><a class="none" name="*cleanup-interval*"></a>
3352       [Special variable]
3353       <br><b>*cleanup-interval*</b><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3354           Should be <code xmlns="http://www.w3.org/1999/xhtml">NIL</code> or a positive integer.  The system calls
3355           <code><a href="#*cleanup-function*">*CLEANUP-FUNCTION*</a></code>
3356           whenever <code><a href="#*cleanup-interval*">*CLEANUP-INTERVAL*</a></code> new worker threads
3357           (counted globally across all acceptors) have been created unless the
3358           value is <code xmlns="http://www.w3.org/1999/xhtml">NIL</code>.  The initial value is 100.
3359           <p xmlns="http://www.w3.org/1999/xhtml">
3360             This variable is only available on LispWorks.
3361           </p>
3362         </clix:description></blockquote></p>
3363
3364
3365
3366   <h3 xmlns=""><a class="none" name="testing">Testing</a></h3>
3367     Hunchentoot comes with a test script which verifies that the
3368     example web server responds as expected.  This test script uses the
3369     <a href="http://weitz.de/drakma/">Drakma</a> HTTP client library
3370     and thus shares a significant amount of its base code with
3371     Hunchentoot itself.  Still, running the test script is a useful
3372     confidence test, and it is also possible to run the script across
3373     machines in order to verify a new Hunchentoot (or, for that matter
3374     Drakma) port.
3375     <p>
3376       To run the confidence test, <a href="#teen-age">start
3377       the example web server</a>.  Then, in your Lisp
3378       listener, type
3379 <pre>(<a class="noborder" href="hunchentoot-test:test-hunchentoot">hunchentoot-test:test-hunchentoot</a> "http://localhost:4242")</pre>
3380 You will see some diagnostic output and a summary line that
3381 reports whether any tests have failed.  (You can also use the
3382 example certificate and key files in the test directory and
3383 start and test an https server instead.)
3384     </p>
3385
3386     <p xmlns=""><a class="none" name="hunchentoot-test:test-hunchentoot"></a>
3387           [Function]
3388           <br><b>hunchentoot-test:test-hunchentoot</b> <i><clix:lambda-list xmlns:clix="http://bknr.net/clixdoc">base-url <tt>&amp;key</tt></clix:lambda-list></i>
3389             =&gt;
3390             <i><clix:returns xmlns:clix="http://bknr.net/clixdoc">|</clix:returns></i><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
3391         Runs the built-in confidence
3392         test.  <code><i>base-url</i></code> is the base URL to use
3393         for testing, it should not have a trailing slash.  The keyword
3394         arguments accepted are for future extension and should not
3395         currently be used.
3396         <p xmlns="http://www.w3.org/1999/xhtml">
3397           The script expects the Hunchentoot example test server to be
3398           running at the given <code xmlns=""><i>base-url</i></code> and
3399           retrieves various pages from that server, expecting certain
3400           responses.
3401         </p>
3402       </clix:description></blockquote></p>
3403
3404
3405   <h3 xmlns=""><a class="none" name="debugging">Debugging</a></h3>
3406     By default, Hunchentoot intercepts all errors that occur while
3407     executing request handlers, logs them to the log file and displays
3408     a static error page to the user.  While developing applications,
3409     you may want to change that behavior so that the debugger is
3410     invoked when an error occurs.  You can set
3411     the <code xmlns=""><a href="#*catch-errors-p*">*CATCH-ERRORS-P*</a></code> to <code>NIL</code> to
3412     make that happen.  Alternatively, you may want to have Hunchentoot
3413     display detailed error information in the error response page.
3414     You can set the <code xmlns=""><a href="#*show-lisp-errors-p*">*SHOW-LISP-ERRORS-P*</a></code> to a
3415     true value to make that happen.  If you don't want to see Lisp
3416     backtraces in these error pages, you can
3417     set <code xmlns=""><a href="#*show-lisp-backtraces-p*">*SHOW-LISP-BACKTRACES-P*</a></code>
3418     to <code>NIL</code>.
3419
3420
3421   <h3 xmlns=""><a class="none" name="history">History</a></h3>
3422
3423     Hunchentoot's predecessor <a href="http://weitz.de/tbnl/">TBNL</a>
3424     (which is short for "To Be Named Later") grew over the years as a
3425     toolkit that I used for various commercial and private
3426     projects. In August 2003, Daniel Barlow started
3427     a <a href="http://article.gmane.org/gmane.lisp.web/148">review of
3428       web APIs</a> on
3429     the <a href="http://www.red-bean.com/lispweb/">lispweb</a> mailing
3430     list and
3431     I <a href="http://article.gmane.org/gmane.lisp.web/153">described</a>
3432     the API of my hitherto-unreleased bunch of code (and christened it
3433     "TBNL").
3434     <p>
3435       It turned out that
3436       <a href="http://www.jeffcaldwell.com/">Jeff Caldwell</a> had
3437       worked on something similar so he emailed me and proposed to
3438       join our efforts. As I had no immediate plans to release my code
3439       (which was poorly organized, undocumented, and mostly
3440       CMUCL-specific), I gave it to Jeff and he worked towards a
3441       release. He added docstrings, refactored, added some stuff, and
3442       based it on KMRCL to make it portable across several Lisp
3443       implementations.
3444     </p>
3445     <p>
3446       Unfortunately, Jeff is at least as busy as I am so he didn't
3447       find the time to finish a full release.  But in spring 2004 I
3448       needed a documented version of the code for a client of mine who
3449       thought it would be good if the toolkit were publicly available
3450       under an open source license. So I took Jeff's code, refactored
3451       again (to sync with the changes I had done in the meantime), and
3452       added documentation.  This resulted in TBNL 0.1.0 (which
3453       initially required mod_lisp as its front-end).
3454     </p>
3455     <p>
3456       In March 2005, Bob Hutchinson sent patches which enabled TBNL to
3457       use other front-ends than mod_lisp.  This made me aware that
3458       TBNL was already <em>almost</em> a full web server, so
3459       eventually I wrote Hunchentoot which <em>was</em> a full web
3460       server, implemented as a wrapper around TBNL.  Hunchentoot 0.1.0
3461       was released at the end of 2005 and was originally
3462       LispWorks-only.
3463     </p>
3464     <p>
3465       Hunchentoot 0.4.0, released in October 2006, was the first
3466       release which also worked with other Common Lisp
3467       implementations.  It is a major rewrite and also incorporates
3468       most of TBNL and replaces it completely.
3469     </p>
3470     <p>
3471       Hunchentoot 1.0.0, released in February 2009, is again a major
3472       rewrite and should be considered work in progress.  It moved to
3473       using
3474       the <a href="http://common-lisp.net/project/usocket/">usocket</a>
3475       and <a href="http://common-lisp.net/project/bordeaux-threads/">Bordeaux
3476       Threads</a> libraries for non-LispWorks Lisps, thereby removing most of
3477       the platform dependent code.  Threading behaviour was made
3478       controllable through the introduction of
3479       taskmasters.  <a href="http://www.cliki.net/mod_lisp">mod_lisp</a>
3480       support and several other things were removed in this release to
3481       simplify the code base (and partly due to the lack of interest).
3482       Several architectural changes (lots of them not
3483       backwards-compatible) were made to ease customization of
3484       Hunchentoot's behaviour.  A significant part of the 1.0.0
3485       redesign was done
3486       by <a href="http://netzhansa.blogspot.com/">Hans Hübner</a>.
3487     </p>
3488
3489
3490   <h3 xmlns=""><a class="none" name="index">Symbol index</a></h3>
3491
3492     Here are all exported symbols of the <code>HUNCHENTOOT</code>
3493     package in alphabetical order linked to their corresponding
3494     documentation entries:
3495
3496     <ul xmlns="">
3497 <li>
3498 <code><a href="#*acceptor*">*acceptor*</a></code><span class="entry-type">Special variable</span>
3499 </li>
3500 <li>
3501 <code><a href="#*catch-errors-p*">*catch-errors-p*</a></code><span class="entry-type">Special variable</span>
3502 </li>
3503 <li>
3504 <code><a href="#*cleanup-function*">*cleanup-function*</a></code><span class="entry-type">Special variable</span>
3505 </li>
3506 <li>
3507 <code><a href="#*cleanup-interval*">*cleanup-interval*</a></code><span class="entry-type">Special variable</span>
3508 </li>
3509 <li>
3510 <code><a href="#*content-types-for-url-rewrite*">*content-types-for-url-rewrite*</a></code><span class="entry-type">Special variable</span>
3511 </li>
3512 <li>
3513 <code><a href="#*default-connection-timeout*">*default-connection-timeout*</a></code><span class="entry-type">Special variable</span>
3514 </li>
3515 <li>
3516 <code><a href="#*default-content-type*">*default-content-type*</a></code><span class="entry-type">Special variable</span>
3517 </li>
3518 <li>
3519 <code><a href="#*dispatch-table*">*dispatch-table*</a></code><span class="entry-type">Special variable</span>
3520 </li>
3521 <li>
3522 <code><a href="#*file-upload-hook*">*file-upload-hook*</a></code><span class="entry-type">Special variable</span>
3523 </li>
3524 <li>
3525 <code><a href="#*header-stream*">*header-stream*</a></code><span class="entry-type">Special variable</span>
3526 </li>
3527 <li>
3528 <code><a href="#*hunchentoot-default-external-format*">*hunchentoot-default-external-format*</a></code><span class="entry-type">Special variable</span>
3529 </li>
3530 <li>
3531 <code><a href="#*lisp-errors-log-level*">*lisp-errors-log-level*</a></code><span class="entry-type">Special variable</span>
3532 </li>
3533 <li>
3534 <code><a href="#*lisp-warnings-log-level*">*lisp-warnings-log-level*</a></code><span class="entry-type">Special variable</span>
3535 </li>
3536 <li>
3537 <code><a href="#*log-lisp-backtraces-p*">*log-lisp-backtraces-p*</a></code><span class="entry-type">Special variable</span>
3538 </li>
3539 <li>
3540 <code><a href="#*log-lisp-errors-p*">*log-lisp-errors-p*</a></code><span class="entry-type">Special variable</span>
3541 </li>
3542 <li>
3543 <code><a href="#*log-lisp-warnings-p*">*log-lisp-warnings-p*</a></code><span class="entry-type">Special variable</span>
3544 </li>
3545 <li>
3546 <code><a href="#*methods-for-post-parameters*">*methods-for-post-parameters*</a></code><span class="entry-type">Special variable</span>
3547 </li>
3548 <li>
3549 <code><a href="#*reply*">*reply*</a></code><span class="entry-type">Special variable</span>
3550 </li>
3551 <li>
3552 <code><a href="#*request*">*request*</a></code><span class="entry-type">Special variable</span>
3553 </li>
3554 <li>
3555 <code><a href="#*rewrite-for-session-urls*">*rewrite-for-session-urls*</a></code><span class="entry-type">Special variable</span>
3556 </li>
3557 <li>
3558 <code><a href="#*session*">*session*</a></code><span class="entry-type">Special variable</span>
3559 </li>
3560 <li>
3561 <code><a href="#*session-gc-frequency*">*session-gc-frequency*</a></code><span class="entry-type">Special variable</span>
3562 </li>
3563 <li>
3564 <code><a href="#*session-max-time*">*session-max-time*</a></code><span class="entry-type">Special variable</span>
3565 </li>
3566 <li>
3567 <code><a href="#*session-secret*">*session-secret*</a></code><span class="entry-type">Special variable</span>
3568 </li>
3569 <li>
3570 <code><a href="#*show-lisp-backtraces-p*">*show-lisp-backtraces-p*</a></code><span class="entry-type">Special variable</span>
3571 </li>
3572 <li>
3573 <code><a href="#*show-lisp-errors-p*">*show-lisp-errors-p*</a></code><span class="entry-type">Special variable</span>
3574 </li>
3575 <li>
3576 <code><a href="#*tmp-directory*">*tmp-directory*</a></code><span class="entry-type">Special variable</span>
3577 </li>
3578 <li>
3579 <code><a href="#*use-remote-addr-for-sessions*">*use-remote-addr-for-sessions*</a></code><span class="entry-type">Special variable</span>
3580 </li>
3581 <li>
3582 <code><a href="#*use-user-agent-for-sessions*">*use-user-agent-for-sessions*</a></code><span class="entry-type">Special variable</span>
3583 </li>
3584 <li>
3585 <code><a href="#+http-accepted+">+http-accepted+</a></code><span class="entry-type">Constant</span>
3586 </li>
3587 <li>
3588 <code><a href="#+http-authorization-required+">+http-authorization-required+</a></code><span class="entry-type">Constant</span>
3589 </li>
3590 <li>
3591 <code><a href="#+http-bad-gateway+">+http-bad-gateway+</a></code><span class="entry-type">Constant</span>
3592 </li>
3593 <li>
3594 <code><a href="#+http-bad-request+">+http-bad-request+</a></code><span class="entry-type">Constant</span>
3595 </li>
3596 <li>
3597 <code><a href="#+http-conflict+">+http-conflict+</a></code><span class="entry-type">Constant</span>
3598 </li>
3599 <li>
3600 <code><a href="#+http-continue+">+http-continue+</a></code><span class="entry-type">Constant</span>
3601 </li>
3602 <li>
3603 <code><a href="#+http-created+">+http-created+</a></code><span class="entry-type">Constant</span>
3604 </li>
3605 <li>
3606 <code><a href="#+http-expectation-failed+">+http-expectation-failed+</a></code><span class="entry-type">Constant</span>
3607 </li>
3608 <li>
3609 <code><a href="#+http-failed-dependency+">+http-failed-dependency+</a></code><span class="entry-type">Constant</span>
3610 </li>
3611 <li>
3612 <code><a href="#+http-forbidden+">+http-forbidden+</a></code><span class="entry-type">Constant</span>
3613 </li>
3614 <li>
3615 <code><a href="#+http-gateway-time-out+">+http-gateway-time-out+</a></code><span class="entry-type">Constant</span>
3616 </li>
3617 <li>
3618 <code><a href="#+http-gone+">+http-gone+</a></code><span class="entry-type">Constant</span>
3619 </li>
3620 <li>
3621 <code><a href="#+http-internal-server-error+">+http-internal-server-error+</a></code><span class="entry-type">Constant</span>
3622 </li>
3623 <li>
3624 <code><a href="#+http-length-required+">+http-length-required+</a></code><span class="entry-type">Constant</span>
3625 </li>
3626 <li>
3627 <code><a href="#+http-method-not-allowed+">+http-method-not-allowed+</a></code><span class="entry-type">Constant</span>
3628 </li>
3629 <li>
3630 <code><a href="#+http-moved-permanently+">+http-moved-permanently+</a></code><span class="entry-type">Constant</span>
3631 </li>
3632 <li>
3633 <code><a href="#+http-moved-temporarily+">+http-moved-temporarily+</a></code><span class="entry-type">Constant</span>
3634 </li>
3635 <li>
3636 <code><a href="#+http-multi-status+">+http-multi-status+</a></code><span class="entry-type">Constant</span>
3637 </li>
3638 <li>
3639 <code><a href="#+http-multiple-choices+">+http-multiple-choices+</a></code><span class="entry-type">Constant</span>
3640 </li>
3641 <li>
3642 <code><a href="#+http-no-content+">+http-no-content+</a></code><span class="entry-type">Constant</span>
3643 </li>
3644 <li>
3645 <code><a href="#+http-non-authoritative-information+">+http-non-authoritative-information+</a></code><span class="entry-type">Constant</span>
3646 </li>
3647 <li>
3648 <code><a href="#+http-not-acceptable+">+http-not-acceptable+</a></code><span class="entry-type">Constant</span>
3649 </li>
3650 <li>
3651 <code><a href="#+http-not-found+">+http-not-found+</a></code><span class="entry-type">Constant</span>
3652 </li>
3653 <li>
3654 <code><a href="#+http-not-implemented+">+http-not-implemented+</a></code><span class="entry-type">Constant</span>
3655 </li>
3656 <li>
3657 <code><a href="#+http-not-modified+">+http-not-modified+</a></code><span class="entry-type">Constant</span>
3658 </li>
3659 <li>
3660 <code><a href="#+http-ok+">+http-ok+</a></code><span class="entry-type">Constant</span>
3661 </li>
3662 <li>
3663 <code><a href="#+http-partial-content+">+http-partial-content+</a></code><span class="entry-type">Constant</span>
3664 </li>
3665 <li>
3666 <code><a href="#+http-payment-required+">+http-payment-required+</a></code><span class="entry-type">Constant</span>
3667 </li>
3668 <li>
3669 <code><a href="#+http-precondition-failed+">+http-precondition-failed+</a></code><span class="entry-type">Constant</span>
3670 </li>
3671 <li>
3672 <code><a href="#+http-proxy-authentication-required+">+http-proxy-authentication-required+</a></code><span class="entry-type">Constant</span>
3673 </li>
3674 <li>
3675 <code><a href="#+http-request-entity-too-large+">+http-request-entity-too-large+</a></code><span class="entry-type">Constant</span>
3676 </li>
3677 <li>
3678 <code><a href="#+http-request-time-out+">+http-request-time-out+</a></code><span class="entry-type">Constant</span>
3679 </li>
3680 <li>
3681 <code><a href="#+http-request-uri-too-large+">+http-request-uri-too-large+</a></code><span class="entry-type">Constant</span>
3682 </li>
3683 <li>
3684 <code><a href="#+http-requested-range-not-satisfiable+">+http-requested-range-not-satisfiable+</a></code><span class="entry-type">Constant</span>
3685 </li>
3686 <li>
3687 <code><a href="#+http-reset-content+">+http-reset-content+</a></code><span class="entry-type">Constant</span>
3688 </li>
3689 <li>
3690 <code><a href="#+http-see-other+">+http-see-other+</a></code><span class="entry-type">Constant</span>
3691 </li>
3692 <li>
3693 <code><a href="#+http-service-unavailable+">+http-service-unavailable+</a></code><span class="entry-type">Constant</span>
3694 </li>
3695 <li>
3696 <code><a href="#+http-switching-protocols+">+http-switching-protocols+</a></code><span class="entry-type">Constant</span>
3697 </li>
3698 <li>
3699 <code><a href="#+http-temporary-redirect+">+http-temporary-redirect+</a></code><span class="entry-type">Constant</span>
3700 </li>
3701 <li>
3702 <code><a href="#+http-unsupported-media-type+">+http-unsupported-media-type+</a></code><span class="entry-type">Constant</span>
3703 </li>
3704 <li>
3705 <code><a href="#+http-use-proxy+">+http-use-proxy+</a></code><span class="entry-type">Constant</span>
3706 </li>
3707 <li>
3708 <code><a href="#+http-version-not-supported+">+http-version-not-supported+</a></code><span class="entry-type">Constant</span>
3709 </li>
3710 <li>
3711 <code><a href="#abort-request-handler">abort-request-handler</a></code><span class="entry-type">Function</span>
3712 </li>
3713 <li>
3714 <code><a href="#accept-connections">accept-connections</a></code><span class="entry-type">Generic function</span>
3715 </li>
3716 <li>
3717 <code><a href="#acceptor">acceptor</a></code><span class="entry-type">Standard class</span>
3718 </li>
3719 <li>
3720 <code><a href="#acceptor-access-log-destination">acceptor-access-log-destination</a></code><span class="entry-type">Generic accessor</span>
3721 </li>
3722 <li>
3723 <code><a href="#acceptor-address">acceptor-address</a></code><span class="entry-type">Generic reader</span>
3724 </li>
3725 <li>
3726 <code><a href="#acceptor-dispatch-request">acceptor-dispatch-request</a></code><span class="entry-type">Generic function</span>
3727 </li>
3728 <li>
3729 <code><a href="#acceptor-document-root">acceptor-document-root</a></code><span class="entry-type">Generic accessor</span>
3730 </li>
3731 <li>
3732 <code><a href="#acceptor-error-template-directory">acceptor-error-template-directory</a></code><span class="entry-type">Generic accessor</span>
3733 </li>
3734 <li>
3735 <code><a href="#acceptor-input-chunking-p">acceptor-input-chunking-p</a></code><span class="entry-type">Generic accessor</span>
3736 </li>
3737 <li>
3738 <code><a href="#acceptor-listen-backlog">acceptor-listen-backlog</a></code><span class="entry-type">Generic function</span>
3739 </li>
3740 <li>
3741 <code><a href="#acceptor-log-access">acceptor-log-access</a></code><span class="entry-type">Generic function</span>
3742 </li>
3743 <li>
3744 <code><a href="#acceptor-log-message">acceptor-log-message</a></code><span class="entry-type">Generic function</span>
3745 </li>
3746 <li>
3747 <code><a href="#acceptor-message-log-destination">acceptor-message-log-destination</a></code><span class="entry-type">Generic accessor</span>
3748 </li>
3749 <li>
3750 <code><a href="#acceptor-name">acceptor-name</a></code><span class="entry-type">Generic accessor</span>
3751 </li>
3752 <li>
3753 <code><a href="#acceptor-output-chunking-p">acceptor-output-chunking-p</a></code><span class="entry-type">Generic accessor</span>
3754 </li>
3755 <li>
3756 <code><a href="#acceptor-persistent-connections-p">acceptor-persistent-connections-p</a></code><span class="entry-type">Generic accessor</span>
3757 </li>
3758 <li>
3759 <code><a href="#acceptor-port">acceptor-port</a></code><span class="entry-type">Generic reader</span>
3760 </li>
3761 <li>
3762 <code><a href="#acceptor-read-timeout">acceptor-read-timeout</a></code><span class="entry-type">Generic reader</span>
3763 </li>
3764 <li>
3765 <code><a href="#acceptor-remove-session">acceptor-remove-session</a></code><span class="entry-type">Generic function</span>
3766 </li>
3767 <li>
3768 <code><a href="#acceptor-reply-class">acceptor-reply-class</a></code><span class="entry-type">Generic accessor</span>
3769 </li>
3770 <li>
3771 <code><a href="#acceptor-request-class">acceptor-request-class</a></code><span class="entry-type">Generic accessor</span>
3772 </li>
3773 <li>
3774 <code><a href="#acceptor-ssl-certificate-file">acceptor-ssl-certificate-file</a></code><span class="entry-type">Generic reader</span>
3775 </li>
3776 <li>
3777 <code><a href="#acceptor-ssl-p">acceptor-ssl-p</a></code><span class="entry-type">Generic function</span>
3778 </li>
3779 <li>
3780 <code><a href="#acceptor-ssl-privatekey-file">acceptor-ssl-privatekey-file</a></code><span class="entry-type">Generic reader</span>
3781 </li>
3782 <li>
3783 <code><a href="#acceptor-ssl-privatekey-password">acceptor-ssl-privatekey-password</a></code><span class="entry-type">Generic reader</span>
3784 </li>
3785 <li>
3786 <code><a href="#acceptor-status-message">acceptor-status-message</a></code><span class="entry-type">Generic function</span>
3787 </li>
3788 <li>
3789 <code><a href="#acceptor-write-timeout">acceptor-write-timeout</a></code><span class="entry-type">Generic reader</span>
3790 </li>
3791 <li>
3792 <code><a href="#authorization">authorization</a></code><span class="entry-type">Function</span>
3793 </li>
3794 <li>
3795 <code><a href="#aux-request-value">aux-request-value</a></code><span class="entry-type">Accessor</span>
3796 </li>
3797 <li>
3798 <code><a href="#content-length">content-length</a></code><span class="entry-type">Generic reader</span>
3799 </li>
3800 <li>
3801 <code><a href="#content-length*">content-length*</a></code><span class="entry-type">Accessor</span>
3802 </li>
3803 <li>
3804 <code><a href="#content-type">content-type</a></code><span class="entry-type">Generic reader</span>
3805 </li>
3806 <li>
3807 <code><a href="#content-type*">content-type*</a></code><span class="entry-type">Accessor</span>
3808 </li>
3809 <li>
3810 <code><a href="#cookie-in">cookie-in</a></code><span class="entry-type">Function</span>
3811 </li>
3812 <li>
3813 <code><a href="#cookie-out">cookie-out</a></code><span class="entry-type">Function</span>
3814 </li>
3815 <li>
3816 <code><a href="#cookies-in">cookies-in</a></code><span class="entry-type">Generic reader</span>
3817 </li>
3818 <li>
3819 <code><a href="#cookies-in*">cookies-in*</a></code><span class="entry-type">Function</span>
3820 </li>
3821 <li>
3822 <code><a href="#cookies-out">cookies-out</a></code><span class="entry-type">Generic accessor</span>
3823 </li>
3824 <li>
3825 <code><a href="#cookies-out*">cookies-out*</a></code><span class="entry-type">Accessor</span>
3826 </li>
3827 <li>
3828 <code><a href="#create-folder-dispatcher-and-handler">create-folder-dispatcher-and-handler</a></code><span class="entry-type">Function</span>
3829 </li>
3830 <li>
3831 <code><a href="#create-prefix-dispatcher">create-prefix-dispatcher</a></code><span class="entry-type">Function</span>
3832 </li>
3833 <li>
3834 <code><a href="#create-regex-dispatcher">create-regex-dispatcher</a></code><span class="entry-type">Function</span>
3835 </li>
3836 <li>
3837 <code><a href="#create-request-handler-thread">create-request-handler-thread</a></code><span class="entry-type">Generic function</span>
3838 </li>
3839 <li>
3840 <code><a href="#create-static-file-dispatcher-and-handler">create-static-file-dispatcher-and-handler</a></code><span class="entry-type">Function</span>
3841 </li>
3842 <li>
3843 <code><a href="#define-easy-handler">define-easy-handler</a></code><span class="entry-type">Macro</span>
3844 </li>
3845 <li>
3846 <code><a href="#delete-aux-request-value">delete-aux-request-value</a></code><span class="entry-type">Function</span>
3847 </li>
3848 <li>
3849 <code><a href="#delete-session-value">delete-session-value</a></code><span class="entry-type">Function</span>
3850 </li>
3851 <li>
3852 <code><a href="#detach-socket">detach-socket</a></code><span class="entry-type">Generic function</span>
3853 </li>
3854 <li>
3855 <code><a href="#dispatch-easy-handlers">dispatch-easy-handlers</a></code><span class="entry-type">Function</span>
3856 </li>
3857 <li>
3858 <code><a href="#easy-acceptor">easy-acceptor</a></code><span class="entry-type">Standard class</span>
3859 </li>
3860 <li>
3861 <code><a href="#easy-ssl-acceptor">easy-ssl-acceptor</a></code><span class="entry-type">Standard class</span>
3862 </li>
3863 <li>
3864 <code><a href="#escape-for-html">escape-for-html</a></code><span class="entry-type">Function</span>
3865 </li>
3866 <li>
3867 <code><a href="#execute-acceptor">execute-acceptor</a></code><span class="entry-type">Generic function</span>
3868 </li>
3869 <li>
3870 <code><a href="#get-parameter">get-parameter</a></code><span class="entry-type">Function</span>
3871 </li>
3872 <li>
3873 <code><a href="#get-parameters">get-parameters</a></code><span class="entry-type">Generic reader</span>
3874 </li>
3875 <li>
3876 <code><a href="#get-parameters*">get-parameters*</a></code><span class="entry-type">Function</span>
3877 </li>
3878 <li>
3879 <code><a href="#handle-if-modified-since">handle-if-modified-since</a></code><span class="entry-type">Function</span>
3880 </li>
3881 <li>
3882 <code><a href="#handle-incoming-connection">handle-incoming-connection</a></code><span class="entry-type">Generic function</span>
3883 </li>
3884 <li>
3885 <code><a href="#handle-request">handle-request</a></code><span class="entry-type">Generic function</span>
3886 </li>
3887 <li>
3888 <code><a href="#handle-static-file">handle-static-file</a></code><span class="entry-type">Function</span>
3889 </li>
3890 <li>
3891 <code><a href="#header-in">header-in</a></code><span class="entry-type">Generic reader</span>
3892 </li>
3893 <li>
3894 <code><a href="#header-in*">header-in*</a></code><span class="entry-type">Function</span>
3895 </li>
3896 <li>
3897 <code><a href="#header-out">header-out</a></code><span class="entry-type">Accessor</span>
3898 </li>
3899 <li>
3900 <code><a href="#headers-in">headers-in</a></code><span class="entry-type">Generic reader</span>
3901 </li>
3902 <li>
3903 <code><a href="#headers-in*">headers-in*</a></code><span class="entry-type">Function</span>
3904 </li>
3905 <li>
3906 <code><a href="#headers-out">headers-out</a></code><span class="entry-type">Generic reader</span>
3907 </li>
3908 <li>
3909 <code><a href="#headers-out*">headers-out*</a></code><span class="entry-type">Function</span>
3910 </li>
3911 <li>
3912 <code><a href="#host">host</a></code><span class="entry-type">Function</span>
3913 </li>
3914 <li>
3915 <code><a href="#http-token-p">http-token-p</a></code><span class="entry-type">Function</span>
3916 </li>
3917 <li>
3918 <code><a href="#hunchentoot-condition">hunchentoot-condition</a></code><span class="entry-type">Condition type</span>
3919 </li>
3920 <li>
3921 <code><a href="#hunchentoot-error">hunchentoot-error</a></code><span class="entry-type">Condition type</span>
3922 </li>
3923 <li>
3924 <code><a href="#hunchentoot-test:test-hunchentoot">hunchentoot-test:test-hunchentoot</a></code><span class="entry-type">Function</span>
3925 </li>
3926 <li>
3927 <code><a href="#hunchentoot-warning">hunchentoot-warning</a></code><span class="entry-type">Condition type</span>
3928 </li>
3929 <li>
3930 <code><a href="#initialize-connection-stream">initialize-connection-stream</a></code><span class="entry-type">Generic function</span>
3931 </li>
3932 <li>
3933 <code><a href="#local-addr">local-addr</a></code><span class="entry-type">Generic reader</span>
3934 </li>
3935 <li>
3936 <code><a href="#local-addr*">local-addr*</a></code><span class="entry-type">Function</span>
3937 </li>
3938 <li>
3939 <code><a href="#local-port">local-port</a></code><span class="entry-type">Generic reader</span>
3940 </li>
3941 <li>
3942 <code><a href="#local-port*">local-port*</a></code><span class="entry-type">Function</span>
3943 </li>
3944 <li>
3945 <code><a href="#log-message*">log-message*</a></code><span class="entry-type">Function</span>
3946 </li>
3947 <li>
3948 <code><a href="#maybe-invoke-debugger">maybe-invoke-debugger</a></code><span class="entry-type">Generic function</span>
3949 </li>
3950 <li>
3951 <code><a href="#mime-type">mime-type</a></code><span class="entry-type">Function</span>
3952 </li>
3953 <li>
3954 <code><a href="#multi-threaded-taskmaster">multi-threaded-taskmaster</a></code><span class="entry-type">Standard class</span>
3955 </li>
3956 <li>
3957 <code><a href="#next-session-id">next-session-id</a></code><span class="entry-type">Generic function</span>
3958 </li>
3959 <li>
3960 <code><a href="#no-cache">no-cache</a></code><span class="entry-type">Function</span>
3961 </li>
3962 <li>
3963 <code><a href="#one-thread-per-connection-taskmaster">one-thread-per-connection-taskmaster</a></code><span class="entry-type">Standard class</span>
3964 </li>
3965 <li>
3966 <code><a href="#parameter">parameter</a></code><span class="entry-type">Function</span>
3967 </li>
3968 <li>
3969 <code><a href="#parameter-error">parameter-error</a></code><span class="entry-type">Condition type</span>
3970 </li>
3971 <li>
3972 <code><a href="#post-parameter">post-parameter</a></code><span class="entry-type">Function</span>
3973 </li>
3974 <li>
3975 <code><a href="#post-parameters">post-parameters</a></code><span class="entry-type">Generic reader</span>
3976 </li>
3977 <li>
3978 <code><a href="#post-parameters*">post-parameters*</a></code><span class="entry-type">Function</span>
3979 </li>
3980 <li>
3981 <code><a href="#process-connection">process-connection</a></code><span class="entry-type">Generic function</span>
3982 </li>
3983 <li>
3984 <code><a href="#process-request">process-request</a></code><span class="entry-type">Generic function</span>
3985 </li>
3986 <li>
3987 <code><a href="#query-string">query-string</a></code><span class="entry-type">Generic reader</span>
3988 </li>
3989 <li>
3990 <code><a href="#query-string*">query-string*</a></code><span class="entry-type">Function</span>
3991 </li>
3992 <li>
3993 <code><a href="#raw-post-data">raw-post-data</a></code><span class="entry-type">Function</span>
3994 </li>
3995 <li>
3996 <code><a href="#real-remote-addr">real-remote-addr</a></code><span class="entry-type">Function</span>
3997 </li>
3998 <li>
3999 <code><a href="#reason-phrase">reason-phrase</a></code><span class="entry-type">Function</span>
4000 </li>
4001 <li>
4002 <code><a href="#recompute-request-parameters">recompute-request-parameters</a></code><span class="entry-type">Function</span>
4003 </li>
4004 <li>
4005 <code><a href="#redirect">redirect</a></code><span class="entry-type">Function</span>
4006 </li>
4007 <li>
4008 <code><a href="#referer">referer</a></code><span class="entry-type">Function</span>
4009 </li>
4010 <li>
4011 <code><a href="#regenerate-session-cookie-value">regenerate-session-cookie-value</a></code><span class="entry-type">Function</span>
4012 </li>
4013 <li>
4014 <code><a href="#remote-addr">remote-addr</a></code><span class="entry-type">Generic reader</span>
4015 </li>
4016 <li>
4017 <code><a href="#remote-addr*">remote-addr*</a></code><span class="entry-type">Function</span>
4018 </li>
4019 <li>
4020 <code><a href="#remote-port">remote-port</a></code><span class="entry-type">Generic reader</span>
4021 </li>
4022 <li>
4023 <code><a href="#remote-port*">remote-port*</a></code><span class="entry-type">Function</span>
4024 </li>
4025 <li>
4026 <code><a href="#remove-session">remove-session</a></code><span class="entry-type">Function</span>
4027 </li>
4028 <li>
4029 <code><a href="#reply">reply</a></code><span class="entry-type">Standard class</span>
4030 </li>
4031 <li>
4032 <code><a href="#reply-external-format">reply-external-format</a></code><span class="entry-type">Generic accessor</span>
4033 </li>
4034 <li>
4035 <code><a href="#reply-external-format*">reply-external-format*</a></code><span class="entry-type">Accessor</span>
4036 </li>
4037 <li>
4038 <code><a href="#request">request</a></code><span class="entry-type">Standard class</span>
4039 </li>
4040 <li>
4041 <code><a href="#request-acceptor">request-acceptor</a></code><span class="entry-type">Generic reader</span>
4042 </li>
4043 <li>
4044 <code><a href="#request-method">request-method</a></code><span class="entry-type">Generic reader</span>
4045 </li>
4046 <li>
4047 <code><a href="#request-method*">request-method*</a></code><span class="entry-type">Function</span>
4048 </li>
4049 <li>
4050 <code><a href="#request-uri">request-uri</a></code><span class="entry-type">Generic reader</span>
4051 </li>
4052 <li>
4053 <code><a href="#request-uri*">request-uri*</a></code><span class="entry-type">Function</span>
4054 </li>
4055 <li>
4056 <code><a href="#require-authorization">require-authorization</a></code><span class="entry-type">Function</span>
4057 </li>
4058 <li>
4059 <code><a href="#reset-connection-stream">reset-connection-stream</a></code><span class="entry-type">Generic function</span>
4060 </li>
4061 <li>
4062 <code><a href="#reset-session-secret">reset-session-secret</a></code><span class="entry-type">Function</span>
4063 </li>
4064 <li>
4065 <code><a href="#reset-sessions">reset-sessions</a></code><span class="entry-type">Function</span>
4066 </li>
4067 <li>
4068 <code><a href="#return-code">return-code</a></code><span class="entry-type">Generic accessor</span>
4069 </li>
4070 <li>
4071 <code><a href="#return-code*">return-code*</a></code><span class="entry-type">Accessor</span>
4072 </li>
4073 <li>
4074 <code><a href="#rfc-1123-date">rfc-1123-date</a></code><span class="entry-type">Function</span>
4075 </li>
4076 <li>
4077 <code><a href="#script-name">script-name</a></code><span class="entry-type">Generic reader</span>
4078 </li>
4079 <li>
4080 <code><a href="#script-name*">script-name*</a></code><span class="entry-type">Function</span>
4081 </li>
4082 <li>
4083 <code><a href="#send-headers">send-headers</a></code><span class="entry-type">Function</span>
4084 </li>
4085 <li>
4086 <code><a href="#server-protocol">server-protocol</a></code><span class="entry-type">Generic reader</span>
4087 </li>
4088 <li>
4089 <code><a href="#server-protocol*">server-protocol*</a></code><span class="entry-type">Function</span>
4090 </li>
4091 <li>
4092 <code><a href="#session">session</a></code><span class="entry-type">Standard class</span>
4093 </li>
4094 <li>
4095 <code><a href="#session-cookie-name">session-cookie-name</a></code><span class="entry-type">Generic function</span>
4096 </li>
4097 <li>
4098 <code><a href="#session-cookie-value">session-cookie-value</a></code><span class="entry-type">Generic function</span>
4099 </li>
4100 <li>
4101 <code><a href="#session-created">session-created</a></code><span class="entry-type">Generic function</span>
4102 </li>
4103 <li>
4104 <code><a href="#session-db">session-db</a></code><span class="entry-type">Generic accessor</span>
4105 </li>
4106 <li>
4107 <code><a href="#session-db-lock">session-db-lock</a></code><span class="entry-type">Generic function</span>
4108 </li>
4109 <li>
4110 <code><a href="#session-gc">session-gc</a></code><span class="entry-type">Function</span>
4111 </li>
4112 <li>
4113 <code><a href="#session-id">session-id</a></code><span class="entry-type">Generic function</span>
4114 </li>
4115 <li>
4116 <code><a href="#session-max-time">session-max-time</a></code><span class="entry-type">Generic accessor</span>
4117 </li>
4118 <li>
4119 <code><a href="#session-remote-addr">session-remote-addr</a></code><span class="entry-type">Generic function</span>
4120 </li>
4121 <li>
4122 <code><a href="#session-start">session-start</a></code><span class="entry-type">Generic function</span>
4123 </li>
4124 <li>
4125 <code><a href="#session-too-old-p">session-too-old-p</a></code><span class="entry-type">Function</span>
4126 </li>
4127 <li>
4128 <code><a href="#session-user-agent">session-user-agent</a></code><span class="entry-type">Generic function</span>
4129 </li>
4130 <li>
4131 <code><a href="#session-value">session-value</a></code><span class="entry-type">Accessor</span>
4132 </li>
4133 <li>
4134 <code><a href="#session-verify">session-verify</a></code><span class="entry-type">Generic function</span>
4135 </li>
4136 <li>
4137 <code><a href="#set-cookie">set-cookie</a></code><span class="entry-type">Function</span>
4138 </li>
4139 <li>
4140 <code><a href="#set-cookie*">set-cookie*</a></code><span class="entry-type">Function</span>
4141 </li>
4142 <li>
4143 <code><a href="#shutdown">shutdown</a></code><span class="entry-type">Generic function</span>
4144 </li>
4145 <li>
4146 <code><a href="#single-threaded-taskmaster">single-threaded-taskmaster</a></code><span class="entry-type">Standard class</span>
4147 </li>
4148 <li>
4149 <code><a href="#ssl-acceptor">ssl-acceptor</a></code><span class="entry-type">Standard class</span>
4150 </li>
4151 <li>
4152 <code><a href="#ssl-p">ssl-p</a></code><span class="entry-type">Function</span>
4153 </li>
4154 <li>
4155 <code><a href="#start">start</a></code><span class="entry-type">Generic function</span>
4156 </li>
4157 <li>
4158 <code><a href="#start-listening">start-listening</a></code><span class="entry-type">Generic function</span>
4159 </li>
4160 <li>
4161 <code><a href="#start-session">start-session</a></code><span class="entry-type">Function</span>
4162 </li>
4163 <li>
4164 <code><a href="#start-thread">start-thread</a></code><span class="entry-type">Generic function</span>
4165 </li>
4166 <li>
4167 <code><a href="#stop">stop</a></code><span class="entry-type">Generic function</span>
4168 </li>
4169 <li>
4170 <code><a href="#taskmaster">taskmaster</a></code><span class="entry-type">Standard class</span>
4171 </li>
4172 <li>
4173 <code><a href="#taskmaster-acceptor">taskmaster-acceptor</a></code><span class="entry-type">Generic accessor</span>
4174 </li>
4175 <li>
4176 <code><a href="#url-decode">url-decode</a></code><span class="entry-type">Function</span>
4177 </li>
4178 <li>
4179 <code><a href="#url-encode">url-encode</a></code><span class="entry-type">Function</span>
4180 </li>
4181 <li>
4182 <code><a href="#user-agent">user-agent</a></code><span class="entry-type">Function</span>
4183 </li>
4184 <li>
4185 <code><a href="#within-request-p">within-request-p</a></code><span class="entry-type">Function</span>
4186 </li>
4187 </ul>
4188
4189
4190
4191   <h3 xmlns=""><a class="none" name="ack">Acknowledgements</a></h3>
4192
4193     Thanks to Jeff Caldwell - TBNL would not have been released
4194     without his efforts.  Thanks
4195     to <a href="http://www.cliki.net/Stefan%20Scholl">Stefan
4196     Scholl</a> and Travis Cross for various additions and fixes to
4197     TBNL, to <a href="http://www.foldr.org/~michaelw/">Michael
4198     Weber</a> for initial file upload code, and
4199     to <a href="http://www.ltn.lv/~jonis/">Janis Dzerins</a> for
4200     his <a href="http://common-lisp.net/project/rfc2388/">RFC 2388
4201     code</a>. Thanks to Bob Hutchison for his code for multiple
4202     front-ends (which made me realize that TBNL was already pretty
4203     close to a "real" web server) and the initial UTF-8 example.
4204     Thanks to <a href="http://netzhansa.blogspot.com/">Hans Hübner</a>
4205     for a lot of architectural and implementation enhancements for the
4206     1.0.0 release and also for transferring the documentation to sane
4207     XHTML.  Thanks to John
4208     Foderaro's <a href="http://opensource.franz.com/aserve/index.html">AllegroServe</a>
4209     for inspiration.  Thanks to <a href="http://www.htg1.de/">Uwe von
4210     Loh</a> for
4211     the <a href="http://www.htg1.de/hunchentoot/hunchentoot.html">Hunchentoot
4212     logo</a>.
4213
4214     <p>
4215       Hunchentoot originally used code
4216       from <a href="http://www.cliki.net/ACL-COMPAT">ACL-COMPAT</a>,
4217       specifically the chunking code from Jochen Schmidt.  (This has been
4218       replaced by <a href="http://weitz.de/chunga/">Chunga</a>.)  When I ported
4219       Hunchentoot to other Lisps than LispWorks, I stole code from
4220       ACL-COMPAT, <a href="http://www.cliki.net/kmrcl">KMRCL</a>,
4221       and <a href="http://www.cliki.net/trivial-sockets">trivial-sockets</a> for
4222       implementation-dependent stuff like sockets and MP.  (This has been replaced by
4223       <a href="http://common-lisp.net/project/bordeaux-threads/">Bordeaux
4224       Threads</a>
4225       and <a href="http://common-lisp.net/project/usocket/">usocket</a>.)
4226     </p>
4227     <p>
4228       Parts of this documentation were prepared
4229       with <a href="http://weitz.de/documentation-template/">DOCUMENTATION-TEMPLATE</a>,
4230       no animals were harmed.
4231     </p>
4232
4233   <p>
4234     <a href="http://weitz.de/index.html">BACK TO MY HOMEPAGE
4235     </a>
4236   </p>
4237 </body></html>