[usocket-cvs] r14 - usocket/trunk/doc

[ehuelsmann at common-lisp.net]

Author: ehuelsmann
Date: Tue Jan 31 12:05:22 2006
New Revision: 14

Modified:
   usocket/trunk/doc/active-sockets-apis.txt
   usocket/trunk/doc/backends.txt
   usocket/trunk/doc/clisp-sockets.txt
   usocket/trunk/doc/cmucl-sockets.txt
   usocket/trunk/doc/sb-bsd-sockets.txt
Log:
Update documentation.

Modified: usocket/trunk/doc/active-sockets-apis.txt
==============================================================================
--- usocket/trunk/doc/active-sockets-apis.txt	(original)
+++ usocket/trunk/doc/active-sockets-apis.txt	Tue Jan 31 12:05:22 2006
@@ -18,6 +18,7 @@
   sockets:
   - socket-bind
   - make-instance 'inet-socket
+  - socket-make-stream
   - socket-connect
   - socket-close
 

Modified: usocket/trunk/doc/backends.txt
==============================================================================
--- usocket/trunk/doc/backends.txt	(original)
+++ usocket/trunk/doc/backends.txt	Tue Jan 31 12:05:22 2006
@@ -20,3 +20,7 @@
  - get-host-by-address (name string)
  - get-hosts-by-name (address vector-quad)
 
+
+An error-handling function, resolving implementation specific errors
+to this list of errors:
+

Modified: usocket/trunk/doc/clisp-sockets.txt
==============================================================================
--- usocket/trunk/doc/clisp-sockets.txt	(original)
+++ usocket/trunk/doc/clisp-sockets.txt	Tue Jan 31 12:05:22 2006
@@ -14,3 +14,13 @@
 (SOCKET:SOCKET-STREAM-LOCAL socket-stream [do-not-resolve-p])
 (SOCKET:SOCKET-STREAM-SHUTDOWN socket-stream direction)
 (SOCKET:SOCKET-OPTIONS socket-server &REST {option}*)
+
+
+(posix:resolve-host-ipaddr &optional host)
+
+with the host-ent structure:
+
+  name      - host name
+  aliases   - LIST of aliases
+  addr-list - LIST of IPs as dotted quads (IPv4) or coloned octets (IPv6)
+  addrtype  - INTEGER address type IPv4 or IPv6

Modified: usocket/trunk/doc/cmucl-sockets.txt
==============================================================================
--- usocket/trunk/doc/cmucl-sockets.txt	(original)
+++ usocket/trunk/doc/cmucl-sockets.txt	Tue Jan 31 12:05:22 2006
@@ -34,6 +34,12 @@
 
 
 
+There's currently only 1 condition to be raised:
+
+  SOCKET-ERROR (derived from SIMPLE-ERROR)
+    which has a SOCKET-ERRNO slot containing the unix error number.
+
+
 
 
 [Function]

Modified: usocket/trunk/doc/sb-bsd-sockets.txt
==============================================================================
--- usocket/trunk/doc/sb-bsd-sockets.txt	(original)
+++ usocket/trunk/doc/sb-bsd-sockets.txt	Tue Jan 31 12:05:22 2006
@@ -86,3 +86,31 @@
 (define-socket-condition sockint::EPROTONOSUPPORT protocol-not-supported-error)
 (define-socket-condition sockint::ESOCKTNOSUPPORT socket-type-not-supported-error)
 (define-socket-condition sockint::ENETUNREACH network-unreachable-error)
+
+Exported errors:
+* (apropos "ERROR" :sb-bsd-sockets)
+ 
+SB-BSD-SOCKETS:INTERRUPTED-ERROR
+SB-BSD-SOCKETS:TRY-AGAIN-ERROR
+SB-BSD-SOCKETS:NO-RECOVERY-ERROR
+SB-BSD-SOCKETS:CONNECTION-REFUSED-ERROR
+SB-BSD-SOCKETS:INVALID-ARGUMENT-ERROR
+SB-BSD-SOCKETS:HOST-NOT-FOUND-ERROR
+SB-BSD-SOCKETS:OPERATION-NOT-PERMITTED-ERROR
+SB-BSD-SOCKETS:SOCKET-ERROR (fbound)  <-- geen condition
+SB-BSD-SOCKETS:NAME-SERVICE-ERROR (fbound)  <-- geen condition
+? --> SB-BSD-SOCKETS:NETDB-INTERNAL-ERROR
+SB-BSD-SOCKETS:OPERATION-NOT-SUPPORTED-ERROR
+SB-BSD-SOCKETS:PROTOCOL-NOT-SUPPORTED-ERROR
+SB-BSD-SOCKETS:OPERATION-TIMEOUT-ERROR
+SB-BSD-SOCKETS:SOCKET-TYPE-NOT-SUPPORTED-ERROR
+SB-BSD-SOCKETS:NO-BUFFERS-ERROR
+SB-BSD-SOCKETS:NETWORK-UNREACHABLE-ERROR
+? --> SB-BSD-SOCKETS:NETDB-SUCCESS-ERROR
+SB-BSD-SOCKETS:BAD-FILE-DESCRIPTOR-ERROR
+SB-BSD-SOCKETS:ADDRESS-IN-USE-ERROR
+SB-BSD-SOCKETS:OUT-OF-MEMORY-ERROR
+
+And 1 non-exported error:
+
+SB-BSD-SOCKETS::NO-ADDRESS-ERROR