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