0.9.2.43:

[sbcl.git] / contrib / sb-bsd-sockets / inet.lisp

diff --git a/contrib/sb-bsd-sockets/inet.lisp b/contrib/sb-bsd-sockets/inet.lisp
index f6a7c17..4cc0684 100644 (file)
--- a/contrib/sb-bsd-sockets/inet.lisp
+++ b/contrib/sb-bsd-sockets/inet.lisp
@@ -1,21 +1,18 @@
 (in-package :sb-bsd-sockets)
 
-#|| <h2>INET-domain sockets</h2>
-
-<p>The TCP and UDP sockets that you know and love.  Some representation issues:
-<ul>
-<li>These functions do not accept hostnames directly: see <a href="#name-service">name resolution</a>
-<li>Internet <b>addresses</b> are represented by sequences of <tt>(unsigned-byte 8)</tt> - viz. <tt>#(127 0 0 1)</tt>.  <b>Ports</b> are just integers: <tt>6010</tt>.  No conversion between network- and host-order data is needed from the user of this package.
-<li><b><i>socket addresses</i></b> are represented by the two values for <b>address</b> and <b>port</b>, so for example, <tt>(<a href="#SOCKET-CONNECT">socket-connect</a> s #(192 168 1 1) 80)</tt>
-</ul>
-
-|#
-
 ;;; Our class and constructor
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
   (defclass inet-socket (socket)
-    ((family :initform sockint::AF-INET))))
+    ((family :initform sockint::AF-INET))
+    (:documentation "Class representing TCP and UDP sockets.
+
+Examples:
+
+ (make-instance 'inet-socket :type :stream :protocol :tcp)
+
+ (make-instance 'inet-socket :type :datagram :protocol :udp)
+")))
 
 ;;; XXX should we *...* this?
 (defparameter inet-address-any (vector 0 0 0 0))
@@ -55,7 +52,7 @@ using getprotobyname(2) which typically looks in NIS or /etc/protocols"
 
       ;; We have no truck with such dreadful type punning.  Octets to
       ;; octets, dust to dust.
-      
+
       (setf (sockint::sockaddr-in-family sockaddr) sockint::af-inet)
       (setf (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 0) (ldb (byte 8 8) port))
       (setf (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 1) (ldb (byte 8 0) port))
@@ -76,11 +73,11 @@ using getprotobyname(2) which typically looks in NIS or /etc/protocols"
   "Returns address and port of SOCKADDR as multiple values"
   (values
    (coerce (loop for i from 0 below 4
-                collect (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) i))
-          '(vector (unsigned-byte 8) 4))
+                 collect (sb-alien:deref (sockint::sockaddr-in-addr sockaddr) i))
+           '(vector (unsigned-byte 8) 4))
    (+ (* 256 (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 0))
       (sb-alien:deref (sockint::sockaddr-in-port sockaddr) 1))))
-   
+
 (defun make-inet-socket (type protocol)
   "Make an INET socket.  Deprecated in favour of make-instance"
   (make-instance 'inet-socket :type type :protocol protocol))