Permalink
Browse files

README: Updated documentation to reflect SEND/RECV changes.

  • Loading branch information...
1 parent f8e3b9a commit 9bea73a385f3df765336424fd2651e161a8f44d0 Josh Marchán committed Oct 12, 2009
Showing with 6 additions and 6 deletions.
  1. +6 −6 README.mkdn
View
@@ -85,35 +85,35 @@ Channel API
Note that this value might be further limited by memory constraints.
-*[generic function]* `send channel value &optional blockp`
+*[generic function]* `send channel value &key`
-*[method]* `send (channel channel) value &optional (blockp t)`
+*[method]* `send (channel channel) value &key (blockp t)`
Tries to send VALUE into CHANNEL. If the channel is unbufferd or buffered but full, this operation
will block until RECV is called on the channel. Returns the channel that the value was sent into.
If blockp is NIL, NIL is returned immediately instead of a channel if attempting to send would
block.
-*[method]* `send (channels sequence) value &optional (blockp t)`
+*[method]* `send (channels sequence) value &key (blockp t)`
SEND may be used on a sequence of channels. SEND will linearly attempt to send VALUE into one of
the channels in the sequence. It will return immediately as soon as it is able to send VALUE into
one channel. If BLOCKP is T (default), SEND will continue to block until one operation succeeds,
otherwise, it will return NIL when the sequence has been exhausted.
-*[generic function]* `recv channel &optional blockp`
+*[generic function]* `recv channel &key`
-*[method]* `recv (channel channel) &optional (blockp t)`
+*[method]* `recv (channel channel) &key (blockp t)`
Tries to receive a value from CHANNEL. If the channel is unbuffered, or buffered but empty, this
operation will block until SEND is called on the channel. Returns two values: 1. The value
received through the channel, and 2. The channel the value was sent into. If BLOCKP is nil, this
operation will not block, and will return `(values NIL NIL)` if attempting it would block.
-*[method]* `recv (channel sequence) &optional (blockp t)`
+*[method]* `recv (channel sequence) &key (blockp t)`
RECV may be used on a sequence of channels. RECV will linearly attempt to receive a value from
one of the channels in teh sequence. It will return immediately as soon as one channel has a value

0 comments on commit 9bea73a

Please sign in to comment.