ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.361 by root, Sun Jan 23 18:53:06 2011 UTC vs.
Revision 1.366 by sf-exg, Thu Feb 3 16:21:08 2011 UTC

58 ev_timer_start (loop, &timeout_watcher); 58 ev_timer_start (loop, &timeout_watcher);
59 59
60 // now wait for events to arrive 60 // now wait for events to arrive
61 ev_run (loop, 0); 61 ev_run (loop, 0);
62 62
63 // unloop was called, so exit 63 // break was called, so exit
64 return 0; 64 return 0;
65 } 65 }
66 66
67=head1 ABOUT THIS DOCUMENT 67=head1 ABOUT THIS DOCUMENT
68 68
868anymore. 868anymore.
869 869
870 ... queue jobs here, make sure they register event watchers as long 870 ... queue jobs here, make sure they register event watchers as long
871 ... as they still have work to do (even an idle watcher will do..) 871 ... as they still have work to do (even an idle watcher will do..)
872 ev_run (my_loop, 0); 872 ev_run (my_loop, 0);
873 ... jobs done or somebody called unloop. yeah! 873 ... jobs done or somebody called break. yeah!
874 874
875=item ev_break (loop, how) 875=item ev_break (loop, how)
876 876
877Can be used to make a call to C<ev_run> return early (but only after it 877Can be used to make a call to C<ev_run> return early (but only after it
878has processed all outstanding events). The C<how> argument must be either 878has processed all outstanding events). The C<how> argument must be either
3188 atexit (program_exits); 3188 atexit (program_exits);
3189 3189
3190 3190
3191=head2 C<ev_async> - how to wake up an event loop 3191=head2 C<ev_async> - how to wake up an event loop
3192 3192
3193In general, you cannot use an C<ev_run> from multiple threads or other 3193In general, you cannot use an C<ev_loop> from multiple threads or other
3194asynchronous sources such as signal handlers (as opposed to multiple event 3194asynchronous sources such as signal handlers (as opposed to multiple event
3195loops - those are of course safe to use in different threads). 3195loops - those are of course safe to use in different threads).
3196 3196
3197Sometimes, however, you need to wake up an event loop you do not control, 3197Sometimes, however, you need to wake up an event loop you do not control,
3198for example because it belongs to another thread. This is what C<ev_async> 3198for example because it belongs to another thread. This is what C<ev_async>
3308trust me. 3308trust me.
3309 3309
3310=item ev_async_send (loop, ev_async *) 3310=item ev_async_send (loop, ev_async *)
3311 3311
3312Sends/signals/activates the given C<ev_async> watcher, that is, feeds 3312Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3313an C<EV_ASYNC> event on the watcher into the event loop. Unlike 3313an C<EV_ASYNC> event on the watcher into the event loop, and instantly
3314returns.
3315
3314C<ev_feed_event>, this call is safe to do from other threads, signal or 3316Unlike C<ev_feed_event>, this call is safe to do from other threads,
3315similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding 3317signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3316section below on what exactly this means). 3318embedding section below on what exactly this means).
3317 3319
3318Note that, as with other watchers in libev, multiple events might get 3320Note that, as with other watchers in libev, multiple events might get
3319compressed into a single callback invocation (another way to look at this 3321compressed into a single callback invocation (another way to look at this
3320is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>, 3322is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3321reset when the event loop detects that). 3323reset when the event loop detects that).
3547 // now associate this with the loop 3549 // now associate this with the loop
3548 ev_set_userdata (EV_A_ u); 3550 ev_set_userdata (EV_A_ u);
3549 ev_set_invoke_pending_cb (EV_A_ l_invoke); 3551 ev_set_invoke_pending_cb (EV_A_ l_invoke);
3550 ev_set_loop_release_cb (EV_A_ l_release, l_acquire); 3552 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
3551 3553
3552 // then create the thread running ev_loop 3554 // then create the thread running ev_run
3553 pthread_create (&u->tid, 0, l_run, EV_A); 3555 pthread_create (&u->tid, 0, l_run, EV_A);
3554 } 3556 }
3555 3557
3556The callback for the C<ev_async> watcher does nothing: the watcher is used 3558The callback for the C<ev_async> watcher does nothing: the watcher is used
3557solely to wake up the event loop so it takes notice of any new watchers 3559solely to wake up the event loop so it takes notice of any new watchers
5222The physical time that is observed. It is apparently strictly monotonic :) 5224The physical time that is observed. It is apparently strictly monotonic :)
5223 5225
5224=item wall-clock time 5226=item wall-clock time
5225 5227
5226The time and date as shown on clocks. Unlike real time, it can actually 5228The time and date as shown on clocks. Unlike real time, it can actually
5227be wrong and jump forwards and backwards, e.g. when the you adjust your 5229be wrong and jump forwards and backwards, e.g. when you adjust your
5228clock. 5230clock.
5229 5231
5230=item watcher 5232=item watcher
5231 5233
5232A data structure that describes interest in certain events. Watchers need 5234A data structure that describes interest in certain events. Watchers need
5235=back 5237=back
5236 5238
5237=head1 AUTHOR 5239=head1 AUTHOR
5238 5240
5239Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael 5241Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5240Magnusson and Emanuele Giaquinta. 5242Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5241 5243

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines