www/hunchentoot-doc.html

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