X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=contrib%2Fsb-bsd-sockets%2Finet.lisp;h=51e79d39bef822a4fc68e33c2b70abc19ae747b2;hb=a2ff6543c79752bfe42578f794bda1c28167fd10;hp=f6a7c1771d1b1b084b90fcd634074165a35ce001;hpb=3bdadd34bc876d4f91f1ac781a77b4f41a506baf;p=sbcl.git
diff --git a/contrib/sb-bsd-sockets/inet.lisp b/contrib/sb-bsd-sockets/inet.lisp
index f6a7c17..51e79d3 100644
--- a/contrib/sb-bsd-sockets/inet.lisp
+++ b/contrib/sb-bsd-sockets/inet.lisp
@@ -1,21 +1,18 @@
(in-package :sb-bsd-sockets)
-#||
INET-domain sockets
-
-The TCP and UDP sockets that you know and love. Some representation issues:
-
-- These functions do not accept hostnames directly: see name resolution
-
- Internet addresses are represented by sequences of (unsigned-byte 8) - viz. #(127 0 0 1). Ports are just integers: 6010. No conversion between network- and host-order data is needed from the user of this package.
-
- socket addresses are represented by the two values for address and port, so for example, (socket-connect s #(192 168 1 1) 80)
-
-
-|#
-
;;; 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))