[usocket-cvs] r266 - public_html

Wed Jun 6 07:11:23 UTC 2007

Author: ehuelsmann
Date: Wed Jun  6 03:11:22 2007
New Revision: 266

Modified:
   public_html/api-docs.shtml
Log:
Start a FAQ.

Modified: public_html/api-docs.shtml
==============================================================================

--- public_html/api-docs.shtml	(original)
+++ public_html/api-docs.shtml	Wed Jun  6 03:11:22 2007
@@ -15,7 +15,13 @@
   </style>
 </head>
 <body>
-<h1>usocket API documentation</h1>
+
+<ul>
+<li><a href="#docs">API documentation</a></li>
+<li><a href="#faqs">How do I ... (FAQ)</a></li>
+</ul>
+
+<h1><a name="docs">usocket API documentation</a></h1>
 
 <p style="font-size:8px">$Id$ <br />
   Work in progress.</p>
@@ -133,12 +139,41 @@
                retrieved from the returned socket by calling <em><a href="#get-local-port">get-local-port</a></em>.</p></dd>
 </dl>
 
+
+<h1><a name="faqs">How do I ...</a></h1>
+
+<dl>
+<dt>... check whether the other end has closed my socket stream?
+</dt>
+<dd>Reading from a stream which has been closed at the remote end
+  signals an END-OF-FILE condition, meaning that reading from the stream
+  and detecting that condition is the way to do it.
+</dd>
+<dt>... check whether reading from a socket stream will block?
+</dt>
+<dd>When you want to check <b>one</b> stream for readiness of input,
+  call the
+  <a href="http://www.lisp.org/HyperSpec/Body/fun_listen.html">listen</a>
+  function on the stream object associated with the socket.
+</dd>
+<dt>... wait for input to become available on (at least) one stream (of a set)
+</dt>
+<dd>Currently, that's hard to do efficiently if you want to use releases.
+  The next minor release (0.4.0) will include this functionality and
+  for all platforms (except SBCL and LispWorks; both Win32) it's already
+  available in trunk (svn://common-lisp.net/project/usocket/svn/usocket/trunk).
+  <br />
+  If you want to use this code you're most welcome and feedback is appreciated.
+</dd>
+
+</dl>
+
+
 <div style="float:left;font-size:x-small;font-weight:bold">
 Back to <a href="http://common-lisp.net/">Common-lisp.net</a>.
 </div>
  <div class="check" style="float:right">
    <a href="http://validator.w3.org/check/referer">Valid XHTML 1.0 Strict</a>
  </div>
-
 </body>
 </html>

