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