[ViewVC] Diff of: cvs/AnyEvent/README

Comparing AnyEvent/README (file contents):
Revision 1.56 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC

     correctly.
     Example: exit on SIGINT
        my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
+   Restart Behaviour
+    While restart behaviour is up to the event loop implementation, most
+    will not restart syscalls (that includes Async::Interrupt and AnyEvent's
+    pure perl implementation).
+   Safe/Unsafe Signals
+    Perl signals can be either "safe" (synchronous to opcode handling) or
+    "unsafe" (asynchronous) - the former might get delayed indefinitely, the
+    latter might corrupt your memory.
+    AnyEvent signal handlers are, in addition, synchronous to the event
+    loop, i.e. they will not interrupt your running perl program but will
+    only be called as part of the normal event handling (just like timer,
+    I/O etc. callbacks, too).
    Signal Races, Delays and Workarounds
     Many event loops (e.g. Glib, Tk, Qt, IO::Async) do not support attaching
     callbacks to signals in a generic way, which is a pity, as you cannot do
     race-free signal handling in perl, requiring C libraries for this.
         You should check $AnyEvent::MODEL before adding to this array,
         though: if it is defined then the event loop has already been
         detected, and the array will be ignored.
         Best use "AnyEvent::post_detect { BLOCK }" when your application
-        allows it,as it takes care of these details.
+        allows it, as it takes care of these details.
         This variable is mainly useful for modules that can do something
         useful when AnyEvent is used and thus want to know when it is
         initialised, but do not need to even load it by default. This array
         provides the means to hook into AnyEvent passively, without loading
         it.
+        Example: To load Coro::AnyEvent whenever Coro and AnyEvent are used
+        together, you could put this into Coro (this is the actual code used
+        by Coro to accomplish this):
+           if (defined $AnyEvent::MODEL) {
+              # AnyEvent already initialised, so load Coro::AnyEvent
+              require Coro::AnyEvent;
+           } else {
+              # AnyEvent not yet initialised, so make sure to load Coro::AnyEvent
+              # as soon as it is
+              push @AnyEvent::post_detect, sub { require Coro::AnyEvent };
+           }
 WHAT TO DO IN A MODULE
     As a module author, you should "use AnyEvent" and call AnyEvent methods
     freely, but you should not load a specific event module or rely on it.
     it's built-in modules) are required to use it.
     That does not mean that AnyEvent won't take advantage of some additional
     modules if they are installed.
-    This section epxlains which additional modules will be used, and how
+    This section explains which additional modules will be used, and how
-    they affect AnyEvent's operetion.
+    they affect AnyEvent's operation.
     Async::Interrupt
         This slightly arcane module is used to implement fast signal
         handling: To my knowledge, there is no way to do completely
         race-free and quick signal handling in pure perl. To ensure that
         10 seconds, look for $AnyEvent::MAX_SIGNAL_LATENCY).
         If this module is available, then it will be used to implement
         signal catching, which means that signals will not be delayed, and
         the event loop will not be interrupted regularly, which is more
-        efficient (And good for battery life on laptops).
+        efficient (and good for battery life on laptops).
         This affects not just the pure-perl event loop, but also other event
         loops that have no signal handling on their own (e.g. Glib, Tk, Qt).
         Some event loops (POE, Event, Event::Lib) offer signal watchers
 FORK
     Most event libraries are not fork-safe. The ones who are usually are
     because they rely on inefficient but fork-safe "select" or "poll" calls.
     Only EV is fully fork-aware.
+    This means that, in general, you cannot fork and do event processing in
+    the child if a watcher was created before the fork (which in turn
+    initialises the event library).
     If you have to fork, you must either do so *before* creating your first
     watcher OR you must not use AnyEvent at all in the child OR you must do
     something completely out of the scope of AnyEvent.
+    The problem of doing event processing in the parent *and* the child is
+    much more complicated: even for backends that *are* fork-aware or
+    fork-safe, their behaviour is not usually what you want: fork clones all
+    watchers, that means all timers, I/O watchers etc. are active in both
+    parent and child, which is almost never what you want.
 SECURITY CONSIDERATIONS
     AnyEvent can be forced to load any event model via
     $ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used
     to execute arbitrary code or directly gain access, it can easily be used

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent/README (file contents): Revision 1.56 by root, Thu Nov 19 01:55:57 2009 UTC vs. Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC

Diff Legend

Comparing AnyEvent/README (file contents):
Revision 1.56 by root, Thu Nov 19 01:55:57 2009 UTC vs.
Revision 1.58 by root, Sun Dec 20 22:49:52 2009 UTC