X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;f=contrib%2Fsb-concurrency%2Fmailbox.lisp;h=dfa6c8ff2e988bc4fc1eddf0606ae9eb6aca50af;hb=4e168fe00bbbb10196ef0bbfad2e85f7d361f5ae;hp=c4acea53184ba757cd0d22383bc61bd9269fcbb3;hpb=1ecff2d1bc56850bf2f262a56402df4683fc57d9;p=sbcl.git

diff --git a/contrib/sb-concurrency/mailbox.lisp b/contrib/sb-concurrency/mailbox.lisp
index c4acea5..dfa6c8f 100644
--- a/contrib/sb-concurrency/mailbox.lisp
+++ b/contrib/sb-concurrency/mailbox.lisp
@@ -18,7 +18,13 @@
 (defstruct (mailbox (:constructor %make-mailbox (queue semaphore name))
                     (:copier nil)
                     (:predicate mailboxp))
-  "Mailbox aka message queue."
+  "Mailbox aka message queue.
+
+SEND-MESSAGE adds a message to the mailbox, RECEIVE-MESSAGE waits till
+a message becomes available, whereas RECEIVE-MESSAGE-NO-HANG is a non-blocking
+variant, and RECEIVE-PENDING-MESSAGES empties the entire mailbox in one go.
+
+Messages can be arbitrary objects"
   (queue (missing-arg) :type queue)
   (semaphore (missing-arg) :type semaphore)
   (name nil))