ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.46 by root, Mon Apr 7 19:46:24 2008 UTC vs.
Revision 1.47 by root, Mon Apr 14 16:09:33 2008 UTC

179=item $cv->wait 179=item $cv->wait
180 180
181Wait (blocking if necessary) until the C<< ->broadcast >> method has been 181Wait (blocking if necessary) until the C<< ->broadcast >> method has been
182called on c<$cv>, while servicing other watchers normally. 182called on c<$cv>, while servicing other watchers normally.
183 183
184Not all event models support a blocking wait - some die in that case, so
185if you are using this from a module, never require a blocking wait, but
186let the caller decide wether the call will block or not (for example,
187by coupling condition variables with some kind of request results and
188supporting callbacks so the caller knows that getting the result will not
189block, while still suppporting blockign waits if the caller so desires).
190
191You can only wait once on a condition - additional calls will return 184You can only wait once on a condition - additional calls will return
192immediately. 185immediately.
186
187Not all event models support a blocking wait - some die in that case
188(programs might want to do that so they stay interactive), so I<if you
189are using this from a module, never require a blocking wait>, but let the
190caller decide wether the call will block or not (for example, by coupling
191condition variables with some kind of request results and supporting
192callbacks so the caller knows that getting the result will not block,
193while still suppporting blocking waits if the caller so desires).
194
195Another reason I<never> to C<< ->wait >> in a module is that you cannot
196sensibly have two C<< ->wait >>'s in parallel, as that would require
197multiple interpreters or coroutines/threads, none of which C<AnyEvent>
198can supply (the coroutine-aware backends C<Coro::EV> and C<Coro::Event>
199explicitly support concurrent C<< ->wait >>'s from different coroutines,
200however).
193 201
194=item $cv->broadcast 202=item $cv->broadcast
195 203
196Flag the condition as ready - a running C<< ->wait >> and all further 204Flag the condition as ready - a running C<< ->wait >> and all further
197calls to C<wait> will return after this method has been called. If nobody 205calls to C<wait> will return after this method has been called. If nobody

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines