--- libev/ev.pod 2010/03/24 18:27:13 1.293 +++ libev/ev.pod 2010/08/29 16:13:12 1.300 @@ -77,7 +77,7 @@ on event-based programming, nor will it introduce event-based programming with libev. -Familarity with event based programming techniques in general is assumed +Familiarity with event based programming techniques in general is assumed throughout this document. =head1 ABOUT LIBEV @@ -194,7 +194,7 @@ not a problem. Example: Make sure we haven't accidentally been linked against the wrong -version. +version (note, however, that this will not detect ABI mismatches :). assert (("libev version mismatch", ev_version_major () == EV_VERSION_MAJOR @@ -707,7 +707,7 @@ Effectively, all C watchers will be delayed by the time spend between C and C, and all C watchers will be rescheduled (that is, they will lose any events that would have -occured while suspended). +occurred while suspended). After calling C you B call I function on the given loop other than C, and you B call C @@ -794,7 +794,7 @@ This "unloop state" will be cleared when entering C again. -It is safe to call C from otuside any C calls. +It is safe to call C from outside any C calls. =item ev_ref (loop) @@ -874,7 +874,7 @@ you do transactions with the outside world and you can't increase the parallelity, then this setting will limit your transaction rate (if you need to poll once per transaction and the I/O collect interval is 0.01, -then you can't do more than 100 transations per second). +then you can't do more than 100 transactions per second). Setting the I can improve the opportunity for saving power, as the program will "bundle" timer callback invocations that @@ -1382,7 +1382,7 @@ you can associate an C watcher to each such watcher, and in the normal watcher callback, you just start the idle watcher. The real processing is done in the idle watcher callback. This causes libev to -continously poll and process kernel event data for the watcher, but when +continuously poll and process kernel event data for the watcher, but when the lock-out case is known to be rare (which in turn is rare :), this is workable. @@ -1406,7 +1406,7 @@ // are not yet ready to handle it. ev_io_stop (EV_A_ w); - // start the idle watcher to ahndle the actual event. + // start the idle watcher to handle the actual event. // it will not be executed as long as other watchers // with the default priority are receiving events. ev_idle_start (EV_A_ &idle); @@ -1470,7 +1470,7 @@ known-to-be-good backend (at the time of this writing, this includes only C and C). The same applies to file descriptors for which non-blocking operation makes no sense (such as -files) - libev doesn't guarentee any specific behaviour in that case. +files) - libev doesn't guarantee any specific behaviour in that case. Another thing you have to watch out for is that it is quite easy to receive "spurious" readiness notifications, that is your callback might @@ -1739,7 +1739,7 @@ // if last_activity + 60. is older than now, we did time out if (timeout < now) { - // timeout occured, take action + // timeout occurred, take action } else { @@ -1776,7 +1776,7 @@ And when there is some activity, simply store the current time in C, no libev calls at all: - last_actiivty = ev_now (loop); + last_activity = ev_now (loop); This technique is slightly more complex, but in most cases where the time-out is unlikely to be triggered, much more efficient. @@ -3344,8 +3344,6 @@ =item w->set (object *) -This is an B feature that might go away in a future version. - This is a variation of a method callback - leaving out the method to call will default the method to C, which makes it possible to use functor objects without having to manually specify the C all @@ -3889,7 +3887,7 @@ If undefined or defined to be C<1> (and the platform supports it), then the respective watcher type is supported. If defined to be C<0>, then it -is not. Disabling watcher types mainly saves codesize. +is not. Disabling watcher types mainly saves code size. =item EV_FEATURES @@ -3919,17 +3917,17 @@ Use larger code to speed up some operations. -Currently this is used to override some inlining decisions (enlarging the roughly -30% code size on amd64. +Currently this is used to override some inlining decisions (enlarging the +code size by roughly 30% on amd64). When optimising for size, use of compiler flags such as C<-Os> with -gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of +gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of assertions. =item C<2> - faster/larger data structures Replaces the small 2-heap for timer management by a faster 4-heap, larger -hash table sizes and so on. This will usually further increase codesize +hash table sizes and so on. This will usually further increase code size and can additionally have an effect on the size of data structures at runtime. @@ -3976,7 +3974,7 @@ =item EV_AVOID_STDIO If this is set to C<1> at compiletime, then libev will avoid using stdio -functions (printf, scanf, perror etc.). This will increase the codesize +functions (printf, scanf, perror etc.). This will increase the code size somewhat, but if your program doesn't otherwise depend on stdio and your libc allows it, this avoids linking in the stdio library which is quite big. @@ -3990,7 +3988,7 @@ signals): Normally, libev tries to deduce the maximum number of signals automatically, but sometimes this fails, in which case it can be specified. Also, using a lower number than detected (C<32> should be -good for about any system in existance) can save some memory, as libev +good for about any system in existence) can save some memory, as libev statically allocates some 12-24 bytes per signal number. =item EV_PID_HASHSIZE @@ -4046,7 +4044,7 @@ =item EV_COMMON By default, all watchers have a C member. By redefining -this macro to a something else you can include more and other types of +this macro to something else you can include more and other types of members. You have to define it each time you include one of the files, though, and it must be identical each time. @@ -4355,7 +4353,7 @@ And of course, some compiler warnings are just plain stupid, or simply wrong (because they don't actually warn about the condition their message seems to warn about). For example, certain older gcc versions had some -warnings that resulted an extreme number of false positives. These have +warnings that resulted in an extreme number of false positives. These have been fixed, but some people still insist on making code warn-free with such buggy versions. @@ -4655,7 +4653,7 @@ as revents flag, and now C does, too. Both C and C symbols were present in 3.x versions -and continue to be present for the forseeable future, so this is mostly a +and continue to be present for the foreseeable future, so this is mostly a documentation change. =item C mechanism replaced by C