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.128 by root, Sat May 24 02:50:45 2008 UTC vs.
Revision 1.129 by elmex, Sat May 24 15:19:30 2008 UTC

237 237
238Although the callback might get passed parameters, their value and 238Although the callback might get passed parameters, their value and
239presence is undefined and you cannot rely on them. Portable AnyEvent 239presence is undefined and you cannot rely on them. Portable AnyEvent
240callbacks cannot use arguments passed to signal watcher callbacks. 240callbacks cannot use arguments passed to signal watcher callbacks.
241 241
242Multiple signal occurances can be clumped together into one callback 242Multiple signal occurrences can be clumped together into one callback
243invocation, and callback invocation will be synchronous. synchronous means 243invocation, and callback invocation will be synchronous. Synchronous means
244that it might take a while until the signal gets handled by the process, 244that it might take a while until the signal gets handled by the process,
245but it is guarenteed not to interrupt any other callbacks. 245but it is guaranteed not to interrupt any other callbacks.
246 246
247The main advantage of using these watchers is that you can share a signal 247The main advantage of using these watchers is that you can share a signal
248between multiple watchers. 248between multiple watchers.
249 249
250This watcher might use C<%SIG>, so programs overwriting those signals 250This watcher might use C<%SIG>, so programs overwriting those signals
310Condition variables can be created by calling the C<< AnyEvent->condvar 310Condition variables can be created by calling the C<< AnyEvent->condvar
311>> method, usually without arguments. The only argument pair allowed is 311>> method, usually without arguments. The only argument pair allowed is
312C<cb>, which specifies a callback to be called when the condition variable 312C<cb>, which specifies a callback to be called when the condition variable
313becomes true. 313becomes true.
314 314
315After creation, the conditon variable is "false" until it becomes "true" 315After creation, the condition variable is "false" until it becomes "true"
316by calling the C<send> method. 316by calling the C<send> method.
317 317
318Condition variables are similar to callbacks, except that you can 318Condition variables are similar to callbacks, except that you can
319optionally wait for them. They can also be called merge points - points 319optionally wait for them. They can also be called merge points - points
320in time where multiple outstandign events have been processed. And yet 320in time where multiple outstanding events have been processed. And yet
321another way to call them is transations - each condition variable can be 321another way to call them is transactions - each condition variable can be
322used to represent a transaction, which finishes at some point and delivers 322used to represent a transaction, which finishes at some point and delivers
323a result. 323a result.
324 324
325Condition variables are very useful to signal that something has finished, 325Condition variables are very useful to signal that something has finished,
326for example, if you write a module that does asynchronous http requests, 326for example, if you write a module that does asynchronous http requests,
332you can block your main program until an event occurs - for example, you 332you can block your main program until an event occurs - for example, you
333could C<< ->recv >> in your main program until the user clicks the Quit 333could C<< ->recv >> in your main program until the user clicks the Quit
334button of your app, which would C<< ->send >> the "quit" event. 334button of your app, which would C<< ->send >> the "quit" event.
335 335
336Note that condition variables recurse into the event loop - if you have 336Note that condition variables recurse into the event loop - if you have
337two pieces of code that call C<< ->recv >> in a round-robbin fashion, you 337two pieces of code that call C<< ->recv >> in a round-robin fashion, you
338lose. Therefore, condition variables are good to export to your caller, but 338lose. Therefore, condition variables are good to export to your caller, but
339you should avoid making a blocking wait yourself, at least in callbacks, 339you should avoid making a blocking wait yourself, at least in callbacks,
340as this asks for trouble. 340as this asks for trouble.
341 341
342Condition variables are represented by hash refs in perl, and the keys 342Condition variables are represented by hash refs in perl, and the keys
443doesn't execute once). 443doesn't execute once).
444 444
445This is the general pattern when you "fan out" into multiple subrequests: 445This is the general pattern when you "fan out" into multiple subrequests:
446use an outer C<begin>/C<end> pair to set the callback and ensure C<end> 446use an outer C<begin>/C<end> pair to set the callback and ensure C<end>
447is called at least once, and then, for each subrequest you start, call 447is called at least once, and then, for each subrequest you start, call
448C<begin> and for eahc subrequest you finish, call C<end>. 448C<begin> and for each subrequest you finish, call C<end>.
449 449
450=back 450=back
451 451
452=head3 METHODS FOR CONSUMERS 452=head3 METHODS FOR CONSUMERS
453 453
475(programs might want to do that to stay interactive), so I<if you are 475(programs might want to do that to stay interactive), so I<if you are
476using this from a module, never require a blocking wait>, but let the 476using this from a module, never require a blocking wait>, but let the
477caller decide whether the call will block or not (for example, by coupling 477caller decide whether the call will block or not (for example, by coupling
478condition variables with some kind of request results and supporting 478condition variables with some kind of request results and supporting
479callbacks so the caller knows that getting the result will not block, 479callbacks so the caller knows that getting the result will not block,
480while still suppporting blocking waits if the caller so desires). 480while still supporting blocking waits if the caller so desires).
481 481
482Another reason I<never> to C<< ->recv >> in a module is that you cannot 482Another reason I<never> to C<< ->recv >> in a module is that you cannot
483sensibly have two C<< ->recv >>'s in parallel, as that would require 483sensibly have two C<< ->recv >>'s in parallel, as that would require
484multiple interpreters or coroutines/threads, none of which C<AnyEvent> 484multiple interpreters or coroutines/threads, none of which C<AnyEvent>
485can supply. 485can supply.
1481speed most when you have lots of watchers, not when you only have a few of 1481speed most when you have lots of watchers, not when you only have a few of
1482them). 1482them).
1483 1483
1484EV is again fastest. 1484EV is again fastest.
1485 1485
1486Perl again comes second. It is noticably faster than the C-based event 1486Perl again comes second. It is noticeably faster than the C-based event
1487loops Event and Glib, although the difference is too small to really 1487loops Event and Glib, although the difference is too small to really
1488matter. 1488matter.
1489 1489
1490POE also performs much better in this case, but is is still far behind the 1490POE also performs much better in this case, but is is still far behind the
1491others. 1491others.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines