[bknr-cvs] edi changed trunk/thirdparty/hunchentoot/doc/index.xml - bknr-cvs@common-lisp.net - mailman3.common-lisp.net

19 Feb 2009

Revision: 4286
Author: edi
URL: http://bknr.net/trac/changeset/4286
Replies
U   trunk/thirdparty/hunchentoot/doc/index.xml
Modified: trunk/thirdparty/hunchentoot/doc/index.xml
===================================================================

--- trunk/thirdparty/hunchentoot/doc/index.xml	2009-02-18 23:30:05 UTC (rev 4285)
+++ trunk/thirdparty/hunchentoot/doc/index.xml	2009-02-18 23:44:44 UTC (rev 4286)
@@ -1060,7 +1060,8 @@
     <clix:subchapter name="requests" title="Request objects">
For each incoming request, the <a href="#acceptors">acceptor</a>
-creates a clix:refREQUEST</clix:ref> object and makes it available
+(in clix:refPROCESS-CONNECTION</clix:ref>) creates
+a clix:refREQUEST</clix:ref> object and makes it available
 to <a href="#handlers">handlers</a> via the special variable
 clix:ref*REQUEST*</clix:ref>.  This object contains all relevant
 information about the request and this section collects the functions
@@ -1431,67 +1432,94 @@
<clix:subchapter name="replies" title="Reply objects">
+For each incoming request, the <a href="#acceptors">acceptor</a>
+(in clix:refPROCESS-CONNECTION</clix:ref>) creates
+a clix:refREPLY</clix:ref> object and makes it available
+to <a href="#handlers">handlers</a> via the special variable
+clix:ref*REPLY*</clix:ref>.  This object contains all relevant
+information (except for the content body) about the reply that will be
+sent to the client and this section collects the functions which can
+be used to query and modify such an object.  In all function
+where clix:argreply</clix:arg> is an optional or keyword parameter,
+the default is clix:ref*REPLY*</clix:ref>.
+
+<p>
+If you need more fine-grained control over the behaviour of reply
+objects, you can subclass clix:refREPLY</clix:ref> and initialize
+the <a href="#acceptor-reply-class"><code>REPLY-CLASS</code></a>
+slot of the clix:refACCEPTOR</clix:ref> class accordingly.  The
+acceptor will generate reply objects of the class named by this
+slot.
+</p>
+
   <clix:class name='reply'>
     clix:descriptionObjects of this class hold all the information
 about an outgoing reply.  They are created automatically by
 Hunchentoot and can be accessed and modified by the corresponding
-handler.
-
+<a href="#handlers">handler</a>.
+<p>
 You should not mess with the slots of these objects directly, but you
-can subclass REPLY in order to implement your own behaviour.  See the
-REPLY-CLASS slot of the ACCEPTOR class.
+can subclass clix:refREPLY</clix:ref> in order to implement your own behaviour.  See the
+<a href="#acceptor-reply-class"><code>:reply-class</code></a> initarg
+of the clix:refACCEPTOR</clix:ref> class.
+</p>
     </clix:description>
   </clix:class>
+  <clix:special-variable name='*reply*'>
+    clix:descriptionThe current clix:refREPLY</clix:ref> object in the context of a request.
+    </clix:description>
+  </clix:special-variable>
-  <clix:accessor name='reply-external-format*'>
-  clix:lambda-list
+
+  <clix:function name='header-out'>
+  clix:lambda-listname 
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnsstring
   </clix:returns>
-    clix:descriptionThe external format of REPLY which is used for character output.
+    clix:description
+     clix:refHEADER-OUT</clix:ref> returns the outgoing http header named by the keyword clix:argname</clix:arg> if there is one, otherwise <code>NIL</code>. <code>SETF</code> of clix:refHEADER-OUT</clix:ref> changes the current value of the header named clix:argname</clix:arg>. If no header named clix:argname</clix:arg> exists, it is created. For backwards compatibility, clix:argname</clix:arg> can also be a string in which case the association between a header and its name is case-insensitive.
+<p>
+    Note that the header 'Set-Cookie' cannot be queried by clix:refHEADER-OUT</clix:ref> and must not be set by <code>SETF</code> of clix:refHEADER-OUT</clix:ref>.
+    See also clix:refHEADERS-OUT*</clix:ref>, clix:refCONTENT-TYPE*</clix:ref>, clix:refCONTENT-LENGTH*</clix:ref>, clix:refCOOKIES-OUT*</clix:ref>, and clix:refCOOKIE-OUT</clix:ref>.
+</p>
     </clix:description>
-  </clix:accessor>
+  </clix:function>
-  <clix:special-variable name='*reply*'>
-    clix:descriptionThe current REPLY object in the context of a request.
-    </clix:description>
-  </clix:special-variable>
-
-  <clix:accessor name='content-length*'>
+  <clix:function name='headers-out*'>
   clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnsalist
   </clix:returns>
-    clix:descriptionThe outgoing &#039;Content-Length&#039; http header of REPLY.
+    clix:descriptionReturns an alist of the outgoing headers associated with the
+clix:refREPLY</clix:ref> object clix:argreply</clix:arg>.  See also clix:refHEADER-OUT</clix:ref>.
     </clix:description>
-  </clix:accessor>
+  </clix:function>
-
-  <clix:accessor name='content-type*'>
+  <clix:accessor name='content-length*'>
   clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnscontent-length
   </clix:returns>
-    clix:descriptionThe outgoing &#039;Content-Type&#039; http header of REPLY.
+    clix:descriptionThe outgoing &#039;Content-Length&#039; http header of clix:argreply</clix:arg>.
     </clix:description>
   </clix:accessor>
-  <clix:accessor name='cookies-out*'>
+
+  <clix:accessor name='content-type*'>
   clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnscontent-type
   </clix:returns>
-    clix:descriptionReturns an alist of the outgoing cookies associated with the
-REPLY object REPLY.
+    clix:descriptionThe outgoing &#039;Content-Type&#039; http header of clix:argreply</clix:arg>.
     </clix:description>
   </clix:accessor>
@@ -1502,44 +1530,45 @@
   </clix:lambda-list>
   clix:returnsresult
   </clix:returns>
-    clix:descriptionReturns the current value of the outgoing cookie named
-NAME. Search is case-sensitive.
+    clix:descriptionReturns the current value of the outgoing <a href="#cookies">cookie</a> named
+clix:argname</clix:arg>. Search is case-sensitive.
     </clix:description>
   </clix:function>
-  <clix:function name='header-out'>
-  clix:lambda-listname 
+  <clix:accessor name='cookies-out*'>
+  clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnsalist
   </clix:returns>
-    clix:descriptionReturns the current value of the outgoing http header named NAME.
-NAME should be a keyword or a string.
+    clix:descriptionReturns an alist of the outgoing <a href="#cookies">cookies</a> associated with the
+clix:refREPLY</clix:ref> object clix:argreply</clix:arg>.
     </clix:description>
-  </clix:function>
+  </clix:accessor>
-  <clix:function name='headers-out*'>
+  <clix:accessor name='return-code*'>
   clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnsreturn-code
   </clix:returns>
-    clix:descriptionReturns an alist of the outgoing headers associated with the
-REPLY object REPLY.
+    clix:descriptionGets or sets the http return code
+    of clix:argreply</clix:arg>.  The return code of
+    each clix:refREPLY</clix:ref> object is initially set
+    to clix:ref+HTTP-OK+</clix:ref>.
     </clix:description>
-  </clix:function>
+  </clix:accessor>
-  <clix:accessor name='return-code*'>
+  <clix:accessor name='reply-external-format*'>
   clix:lambda-list
   clix:lkwoptional
   </clix:lkw> reply
   </clix:lambda-list>
-  clix:returnsresult
+  clix:returnsexternal-format
   </clix:returns>
-    clix:descriptionThe http return code of REPLY.  The return codes Hunchentoot can
-handle are defined in specials.lisp.
+    clix:descriptionThe external format of clix:argreply</clix:arg> which is used for character output.
     </clix:description>
   </clix:accessor>

    