*** empty log message ***

[software/libev.git] / ev.html
diff --git a/ev.html b/ev.html

index 5fa8652a8e3adf09c58de40edd7af264c097a484..9739c2d2811217372dc87d7e6c5a0cafd43f4660 100644 (file)
--- a/ev.html
+++ b/ev.html
@@ -6,7 +6,7 @@
         <meta name="description" content="Pod documentation for libev" />
         <meta name="inputfile" content="&lt;standard input&gt;" />
         <meta name="outputfile" content="&lt;standard output&gt;" />
         <meta name="description" content="Pod documentation for libev" />
         <meta name="inputfile" content="&lt;standard input&gt;" />
         <meta name="outputfile" content="&lt;standard output&gt;" />
-       <meta name="created" content="Mon Nov 12 09:03:30 2007" />
+       <meta name="created" content="Mon Nov 12 09:16:01 2007" />
         <meta name="generator" content="Pod::Xhtml 1.57" />
  <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
  <body>
         <meta name="generator" content="Pod::Xhtml 1.57" />
  <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
  <body>
@@ -57,7 +57,7 @@
  <div id="DESCRIPTION_CONTENT">
  <p>Libev is an event loop: you register interest in certain events (such as a
  file descriptor being readable or a timeout occuring), and it will manage
  <div id="DESCRIPTION_CONTENT">
  <p>Libev is an event loop: you register interest in certain events (such as a
  file descriptor being readable or a timeout occuring), and it will manage
-these event sources and provide your program events.</p>
+these event sources and provide your program with events.</p>
  <p>To do this, it must take more or less complete control over your process
  (or thread) by executing the <i>event loop</i> handler, and will then
  communicate events via a callback mechanism.</p>
  <p>To do this, it must take more or less complete control over your process
  (or thread) by executing the <i>event loop</i> handler, and will then
  communicate events via a callback mechanism.</p>
@@ -73,14 +73,16 @@ watcher.</p>
  kqueue mechanisms for file descriptor events, relative timers, absolute
  timers with customised rescheduling, signal events, process status change
  events (related to SIGCHLD), and event watchers dealing with the event
  kqueue mechanisms for file descriptor events, relative timers, absolute
  timers with customised rescheduling, signal events, process status change
  events (related to SIGCHLD), and event watchers dealing with the event
-loop mechanism itself (idle, prepare and check watchers).</p>
+loop mechanism itself (idle, prepare and check watchers). It also is quite
+fast (see this <a href="http://libev.schmorp.de/bench.html">benchmark</a> comparing
+it to libevent for example).</p>
  
  </div>
  <h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  <div id="CONVENTIONS_CONTENT">
  <p>Libev is very configurable. In this manual the default configuration
  will be described, which supports multiple event loops. For more info
  
  </div>
  <h1 id="CONVENTIONS">CONVENTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  <div id="CONVENTIONS_CONTENT">
  <p>Libev is very configurable. In this manual the default configuration
  will be described, which supports multiple event loops. For more info
-about various configuraiton options please have a look at the file
+about various configuration options please have a look at the file
  <cite>README.embed</cite> in the libev distribution. If libev was configured without
  support for multiple event loops, then all functions taking an initial
  argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)
  <cite>README.embed</cite> in the libev distribution. If libev was configured without
  support for multiple event loops, then all functions taking an initial
  argument of name <code>loop</code> (which is always of type <code>struct ev_loop *</code>)
@@ -115,10 +117,10 @@ not a problem.</p>
         <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
         <dd>
                 <p>Sets the allocation function to use (the prototype is similar to the
         <dt>ev_set_allocator (void *(*cb)(void *ptr, long size))</dt>
         <dd>
                 <p>Sets the allocation function to use (the prototype is similar to the
-realloc function). It is used to allocate and free memory (no surprises
-here). If it returns zero when memory needs to be allocated, the library
-might abort or take some potentially destructive action. The default is
-your system realloc function.</p>
+realloc C function, the semantics are identical). It is used to allocate
+and free memory (no surprises here). If it returns zero when memory
+needs to be allocated, the library might abort or take some potentially
+destructive action. The default is your system realloc function.</p>
                 <p>You could override this function in high-availability programs to, say,
  free some memory if it cannot allocate memory, to use a special allocator,
  or even to sleep a while and retry until some memory is available.</p>
                 <p>You could override this function in high-availability programs to, say,
  free some memory if it cannot allocate memory, to use a special allocator,
  or even to sleep a while and retry until some memory is available.</p>
@@ -129,7 +131,7 @@ or even to sleep a while and retry until some memory is available.</p>
  as failed select, poll, epoll_wait). The message is a printable string
  indicating the system call or subsystem causing the problem. If this
  callback is set, then libev will expect it to remedy the sitution, no
  as failed select, poll, epoll_wait). The message is a printable string
  indicating the system call or subsystem causing the problem. If this
  callback is set, then libev will expect it to remedy the sitution, no
-matter what, when it returns. That is, libev will geenrally retry the
+matter what, when it returns. That is, libev will generally retry the
  requested operation, or, if the condition doesn't go away, do bad stuff
  (such as abort).</p>
         </dd>
  requested operation, or, if the condition doesn't go away, do bad stuff
  (such as abort).</p>
         </dd>
@@ -143,9 +145,10 @@ types of such loops, the <i>default</i> loop, which supports signals and child
  events, and dynamically created loops which do not.</p>
  <p>If you use threads, a common model is to run the default event loop
  in your main thread (or in a separate thrad) and for each thread you
  events, and dynamically created loops which do not.</p>
  <p>If you use threads, a common model is to run the default event loop
  in your main thread (or in a separate thrad) and for each thread you
-create, you also create another event loop. Libev itself does no lockign
-whatsoever, so if you mix calls to different event loops, make sure you
-lock (this is usually a bad idea, though, even if done right).</p>
+create, you also create another event loop. Libev itself does no locking
+whatsoever, so if you mix calls to the same event loop in different
+threads, make sure you lock (this is usually a bad idea, though, even if
+done correctly, because its hideous and inefficient).</p>
  <dl>
         <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt>
         <dd>
  <dl>
         <dt>struct ev_loop *ev_default_loop (unsigned int flags)</dt>
         <dd>
@@ -318,8 +321,8 @@ corresponding stop function (<code>ev_&lt;type&gt;_stop (loop, watcher *)</code>
  <p>As long as your watcher is active (has been started but not stopped) you
  must not touch the values stored in it. Most specifically you must never
  reinitialise it or call its set method.</p>
  <p>As long as your watcher is active (has been started but not stopped) you
  must not touch the values stored in it. Most specifically you must never
  reinitialise it or call its set method.</p>
-<p>You cna check wether an event is active by calling the <code>ev_is_active
-(watcher *)</code> macro. To see wether an event is outstanding (but the
+<p>You cna check whether an event is active by calling the <code>ev_is_active
+(watcher *)</code> macro. To see whether an event is outstanding (but the
  callback for it has not been called yet) you cna use the <code>ev_is_pending
  (watcher *)</code> macro.</p>
  <p>Each and every callback receives the event loop pointer as first, the
  callback for it has not been called yet) you cna use the <code>ev_is_pending
  (watcher *)</code> macro.</p>
  <p>Each and every callback receives the event loop pointer as first, the
@@ -424,7 +427,7 @@ information given in the last section.</p>
  </div>
  <h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2>
  <div id="struct_ev_io_is_my_file_descriptor_r-2">
  </div>
  <h2 id="struct_ev_io_is_my_file_descriptor_r">struct ev_io - is my file descriptor readable or writable</h2>
  <div id="struct_ev_io_is_my_file_descriptor_r-2">
-<p>I/O watchers check wether a file descriptor is readable or writable
+<p>I/O watchers check whether a file descriptor is readable or writable
  in each iteration of the event loop (This behaviour is called
  level-triggering because you keep receiving events as long as the
  condition persists. Remember you cna stop the watcher if you don't want to
  in each iteration of the event loop (This behaviour is called
  level-triggering because you keep receiving events as long as the
  condition persists. Remember you cna stop the watcher if you don't want to