Update of /project/net-nittin-irc/cvsroot/net-nittin-irc In directory common-lisp.net:/tmp/cvs-serv11616

Modified Files: protocol.lisp Log Message: adding a few better docstrings

Date: Sat Nov 22 14:24:13 2003 Author: eenge

Index: net-nittin-irc/protocol.lisp diff -u net-nittin-irc/protocol.lisp:1.12 net-nittin-irc/protocol.lisp:1.13 --- net-nittin-irc/protocol.lisp:1.12 Fri Nov 14 15:35:01 2003 +++ net-nittin-irc/protocol.lisp Sat Nov 22 14:24:13 2003 @@ -1,4 +1,4 @@ -;;;; $Id: protocol.lisp,v 1.12 2003/11/14 20:35:01 bmastenbrook Exp $ +;;;; $Id: protocol.lisp,v 1.13 2003/11/22 19:24:13 eenge Exp $ ;;;; $Source: /project/net-nittin-irc/cvsroot/net-nittin-irc/protocol.lisp,v $

;;;; See LICENSE for licensing information. @@ -106,6 +106,8 @@ (force-output stream)))

(defmethod connectedp ((connection connection)) + "Returns t if `connection' is connected to a server and is ready for +input." (let ((stream (server-stream connection))) (and (streamp stream) (open-stream-p stream)))) @@ -129,14 +131,16 @@ (when *debug-p* (format *debug-stream* "~A" (describe message))) (irc-message-event message) - message))) ; needed because of the "loop while" in read-meesage-loop + message))) ; needed because of the "loop while" in read-message-loop (stream-error () (setf read-more-p nil)))))

(defmethod read-message-loop ((connection connection)) + "Read messages from the `connection', parse them and dispatch +irc-message-event on them." (loop while (read-message connection)))

(defmethod read-irc-message ((connection connection)) - "Read an IRC-message from the connection." + "Read and parse an IRC-message from the `connection'." (let ((message (create-irc-message (read-line (server-stream connection) t)))) (setf (connection message) connection)