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

[ehuelsmann at common-lisp.net]

Author: ehuelsmann
Date: Wed Feb  1 16:02:27 2006
New Revision: 19

Modified:
   usocket/trunk/doc/active-sockets-apis.txt
   usocket/trunk/doc/clisp-sockets.txt
   usocket/trunk/doc/sb-bsd-sockets.txt
Log:
Update with latest code+docs research.

Modified: usocket/trunk/doc/active-sockets-apis.txt
==============================================================================
--- usocket/trunk/doc/active-sockets-apis.txt	(original)
+++ usocket/trunk/doc/active-sockets-apis.txt	Wed Feb  1 16:02:27 2006
@@ -19,7 +19,7 @@
   - socket-bind
   - make-instance 'inet-socket
   - socket-make-stream
-  - socket-connect
+  - socket-connect (ip vector-quad) port
   - socket-close
 
   DNS name resolution:
@@ -33,7 +33,7 @@
 =====
 
   sockets:
-  - ext:connect-to-inet-socket
+  - ext:connect-to-inet-socket (ip integer) port
   - sys:make-fd-stream
   - ext:close-socket
 
@@ -43,3 +43,33 @@
   - ext:host-entry-addr-list
   - ext:lookup-host-entry
 
+
+ABCL
+====
+
+  sockets
+  - ext:socket-connect (hostname string) port
+  - ext:get-socket-stream
+  - ext:socket-close
+
+
+clisp
+=====
+
+  sockets
+  - socket-connect port (hostname string)
+  - close (socket)
+
+
+Allegro
+=======
+
+  sockets
+  - make-socket
+  - socket-connect
+  - close
+
+  DNS resolution
+  - lookup-hostname
+  - ipaddr-to-hostname
+

Modified: usocket/trunk/doc/clisp-sockets.txt
==============================================================================
--- usocket/trunk/doc/clisp-sockets.txt	(original)
+++ usocket/trunk/doc/clisp-sockets.txt	Wed Feb  1 16:02:27 2006
@@ -24,3 +24,15 @@
   aliases   - LIST of aliases
   addr-list - LIST of IPs as dotted quads (IPv4) or coloned octets (IPv6)
   addrtype  - INTEGER address type IPv4 or IPv6
+
+
+Errors are of type
+
+SYSTEM::SIMPLE-OS-ERROR
+ with a 1 element (integer) SYSTEM::$FORMAT-ARGUMENTS list
+
+This integer stores the OS error reported; meaning WSA* codes on Win32
+and E* codes on *nix, only: unix.lisp in CMUCL shows
+BSD, Linux and SRV4 have different number assignments for the same
+E* constant names  :-(
+

Modified: usocket/trunk/doc/sb-bsd-sockets.txt
==============================================================================
--- usocket/trunk/doc/sb-bsd-sockets.txt	(original)
+++ usocket/trunk/doc/sb-bsd-sockets.txt	Wed Feb  1 16:02:27 2006
@@ -89,24 +89,20 @@
 
 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:NO-RECOVERY-ERROR (EFAIL?)
 SB-BSD-SOCKETS:CONNECTION-REFUSED-ERROR
 SB-BSD-SOCKETS:INVALID-ARGUMENT-ERROR
-SB-BSD-SOCKETS:HOST-NOT-FOUND-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
@@ -114,3 +110,5 @@
 And 1 non-exported error:
 
 SB-BSD-SOCKETS::NO-ADDRESS-ERROR
+
+*-ed errors aren't yet addressed in the errorlist supported by usocket