… | |
… | |
4 | <head> |
4 | <head> |
5 | <title>libev</title> |
5 | <title>libev</title> |
6 | <meta name="description" content="Pod documentation for libev" /> |
6 | <meta name="description" content="Pod documentation for libev" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
7 | <meta name="inputfile" content="<standard input>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
8 | <meta name="outputfile" content="<standard output>" /> |
9 | <meta name="created" content="Mon Nov 12 09:58:27 2007" /> |
9 | <meta name="created" content="Sun Nov 18 04:43:20 2007" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
10 | <meta name="generator" content="Pod::Xhtml 1.57" /> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
11 | <link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
12 | <body> |
12 | <body> |
13 | <div class="pod"> |
13 | <div class="pod"> |
14 | <!-- INDEX START --> |
14 | <!-- INDEX START --> |
… | |
… | |
35 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
35 | <li><a href="#code_ev_idle_code_when_you_ve_got_no"><code>ev_idle</code> - when you've got nothing better to do</a></li> |
36 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
36 | <li><a href="#code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</a></li> |
37 | </ul> |
37 | </ul> |
38 | </li> |
38 | </li> |
39 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
39 | <li><a href="#OTHER_FUNCTIONS">OTHER FUNCTIONS</a></li> |
|
|
40 | <li><a href="#LIBEVENT_EMULATION">LIBEVENT EMULATION</a></li> |
|
|
41 | <li><a href="#C_SUPPORT">C++ SUPPORT</a></li> |
40 | <li><a href="#AUTHOR">AUTHOR</a> |
42 | <li><a href="#AUTHOR">AUTHOR</a> |
41 | </li> |
43 | </li> |
42 | </ul><hr /> |
44 | </ul><hr /> |
43 | <!-- INDEX END --> |
45 | <!-- INDEX END --> |
44 | |
46 | |
… | |
… | |
99 | to the double type in C.</p> |
101 | to the double type in C.</p> |
100 | |
102 | |
101 | </div> |
103 | </div> |
102 | <h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
104 | <h1 id="GLOBAL_FUNCTIONS">GLOBAL FUNCTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
103 | <div id="GLOBAL_FUNCTIONS_CONTENT"> |
105 | <div id="GLOBAL_FUNCTIONS_CONTENT"> |
|
|
106 | <p>These functions can be called anytime, even before initialising the |
|
|
107 | library in any way.</p> |
104 | <dl> |
108 | <dl> |
105 | <dt>ev_tstamp ev_time ()</dt> |
109 | <dt>ev_tstamp ev_time ()</dt> |
106 | <dd> |
110 | <dd> |
107 | <p>Returns the current time as libev would use it.</p> |
111 | <p>Returns the current time as libev would use it. Please note that the |
|
|
112 | <code>ev_now</code> function is usually faster and also often returns the timestamp |
|
|
113 | you actually want to know.</p> |
108 | </dd> |
114 | </dd> |
109 | <dt>int ev_version_major ()</dt> |
115 | <dt>int ev_version_major ()</dt> |
110 | <dt>int ev_version_minor ()</dt> |
116 | <dt>int ev_version_minor ()</dt> |
111 | <dd> |
117 | <dd> |
112 | <p>You can find out the major and minor version numbers of the library |
118 | <p>You can find out the major and minor version numbers of the library |
… | |
… | |
264 | your process until at least one new event arrives, and will return after |
270 | your process until at least one new event arrives, and will return after |
265 | one iteration of the loop.</p> |
271 | one iteration of the loop.</p> |
266 | <p>This flags value could be used to implement alternative looping |
272 | <p>This flags value could be used to implement alternative looping |
267 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
273 | constructs, but the <code>prepare</code> and <code>check</code> watchers provide a better and |
268 | more generic mechanism.</p> |
274 | more generic mechanism.</p> |
|
|
275 | <p>Here are the gory details of what ev_loop does:</p> |
|
|
276 | <pre> 1. If there are no active watchers (reference count is zero), return. |
|
|
277 | 2. Queue and immediately call all prepare watchers. |
|
|
278 | 3. If we have been forked, recreate the kernel state. |
|
|
279 | 4. Update the kernel state with all outstanding changes. |
|
|
280 | 5. Update the "event loop time". |
|
|
281 | 6. Calculate for how long to block. |
|
|
282 | 7. Block the process, waiting for events. |
|
|
283 | 8. Update the "event loop time" and do time jump handling. |
|
|
284 | 9. Queue all outstanding timers. |
|
|
285 | 10. Queue all outstanding periodics. |
|
|
286 | 11. If no events are pending now, queue all idle watchers. |
|
|
287 | 12. Queue all check watchers. |
|
|
288 | 13. Call all queued watchers in reverse order (i.e. check watchers first). |
|
|
289 | 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
|
|
290 | was used, return, otherwise continue with step #1. |
|
|
291 | |
|
|
292 | </pre> |
269 | </dd> |
293 | </dd> |
270 | <dt>ev_unloop (loop, how)</dt> |
294 | <dt>ev_unloop (loop, how)</dt> |
271 | <dd> |
295 | <dd> |
272 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
296 | <p>Can be used to make a call to <code>ev_loop</code> return early (but only after it |
273 | has processed all outstanding events). The <code>how</code> argument must be either |
297 | has processed all outstanding events). The <code>how</code> argument must be either |
274 | <code>EVUNLOOP_ONCE</code>, which will make the innermost <code>ev_loop</code> call return, or |
298 | <code>EVUNLOOP_ONE</code>, which will make the innermost <code>ev_loop</code> call return, or |
275 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
299 | <code>EVUNLOOP_ALL</code>, which will make all nested <code>ev_loop</code> calls return.</p> |
276 | </dd> |
300 | </dd> |
277 | <dt>ev_ref (loop)</dt> |
301 | <dt>ev_ref (loop)</dt> |
278 | <dt>ev_unref (loop)</dt> |
302 | <dt>ev_unref (loop)</dt> |
279 | <dd> |
303 | <dd> |
… | |
… | |
438 | <p>I/O watchers check whether a file descriptor is readable or writable |
462 | <p>I/O watchers check whether a file descriptor is readable or writable |
439 | in each iteration of the event loop (This behaviour is called |
463 | in each iteration of the event loop (This behaviour is called |
440 | level-triggering because you keep receiving events as long as the |
464 | level-triggering because you keep receiving events as long as the |
441 | condition persists. Remember you can stop the watcher if you don't want to |
465 | condition persists. Remember you can stop the watcher if you don't want to |
442 | act on the event and neither want to receive future events).</p> |
466 | act on the event and neither want to receive future events).</p> |
443 | <p>In general you can register as many read and/or write event watchers oer |
467 | <p>In general you can register as many read and/or write event watchers per |
444 | fd as you want (as long as you don't confuse yourself). Setting all file |
468 | fd as you want (as long as you don't confuse yourself). Setting all file |
445 | descriptors to non-blocking mode is also usually a good idea (but not |
469 | descriptors to non-blocking mode is also usually a good idea (but not |
446 | required if you know what you are doing).</p> |
470 | required if you know what you are doing).</p> |
447 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
471 | <p>You have to be careful with dup'ed file descriptors, though. Some backends |
448 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
472 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
449 | descriptors correctly if you register interest in two or more fds pointing |
473 | descriptors correctly if you register interest in two or more fds pointing |
450 | to the same file/socket etc. description.</p> |
474 | to the same underlying file/socket etc. description (that is, they share |
|
|
475 | the same underlying "file open").</p> |
451 | <p>If you must do this, then force the use of a known-to-be-good backend |
476 | <p>If you must do this, then force the use of a known-to-be-good backend |
452 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
477 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
453 | EVMETHOD_POLL).</p> |
478 | EVMETHOD_POLL).</p> |
454 | <dl> |
479 | <dl> |
455 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
480 | <dt>ev_io_init (ev_io *, callback, int fd, int events)</dt> |
… | |
… | |
465 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
490 | <h2 id="code_ev_timer_code_relative_and_opti"><code>ev_timer</code> - relative and optionally recurring timeouts</h2> |
466 | <div id="code_ev_timer_code_relative_and_opti-2"> |
491 | <div id="code_ev_timer_code_relative_and_opti-2"> |
467 | <p>Timer watchers are simple relative timers that generate an event after a |
492 | <p>Timer watchers are simple relative timers that generate an event after a |
468 | given time, and optionally repeating in regular intervals after that.</p> |
493 | given time, and optionally repeating in regular intervals after that.</p> |
469 | <p>The timers are based on real time, that is, if you register an event that |
494 | <p>The timers are based on real time, that is, if you register an event that |
470 | times out after an hour and youreset your system clock to last years |
495 | times out after an hour and you reset your system clock to last years |
471 | time, it will still time out after (roughly) and hour. "Roughly" because |
496 | time, it will still time out after (roughly) and hour. "Roughly" because |
472 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
497 | detecting time jumps is hard, and some inaccuracies are unavoidable (the |
473 | monotonic clock option helps a lot here).</p> |
498 | monotonic clock option helps a lot here).</p> |
474 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
499 | <p>The relative timeouts are calculated relative to the <code>ev_now ()</code> |
475 | time. This is usually the right thing as this timestamp refers to the time |
500 | time. This is usually the right thing as this timestamp refers to the time |
476 | of the event triggering whatever timeout you are modifying/starting. If |
501 | of the event triggering whatever timeout you are modifying/starting. If |
477 | you suspect event processing to be delayed and you *need* to base the timeout |
502 | you suspect event processing to be delayed and you <i>need</i> to base the timeout |
478 | ion the current time, use something like this to adjust for this:</p> |
503 | on the current time, use something like this to adjust for this:</p> |
479 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
504 | <pre> ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
480 | |
505 | |
481 | </pre> |
506 | </pre> |
|
|
507 | <p>The callback is guarenteed to be invoked only when its timeout has passed, |
|
|
508 | but if multiple timers become ready during the same loop iteration then |
|
|
509 | order of execution is undefined.</p> |
482 | <dl> |
510 | <dl> |
483 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
511 | <dt>ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)</dt> |
484 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
512 | <dt>ev_timer_set (ev_timer *, ev_tstamp after, ev_tstamp repeat)</dt> |
485 | <dd> |
513 | <dd> |
486 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
514 | <p>Configure the timer to trigger after <code>after</code> seconds. If <code>repeat</code> is |
… | |
… | |
488 | timer will automatically be configured to trigger again <code>repeat</code> seconds |
516 | timer will automatically be configured to trigger again <code>repeat</code> seconds |
489 | later, again, and again, until stopped manually.</p> |
517 | later, again, and again, until stopped manually.</p> |
490 | <p>The timer itself will do a best-effort at avoiding drift, that is, if you |
518 | <p>The timer itself will do a best-effort at avoiding drift, that is, if you |
491 | configure a timer to trigger every 10 seconds, then it will trigger at |
519 | configure a timer to trigger every 10 seconds, then it will trigger at |
492 | exactly 10 second intervals. If, however, your program cannot keep up with |
520 | exactly 10 second intervals. If, however, your program cannot keep up with |
493 | the timer (ecause it takes longer than those 10 seconds to do stuff) the |
521 | the timer (because it takes longer than those 10 seconds to do stuff) the |
494 | timer will not fire more than once per event loop iteration.</p> |
522 | timer will not fire more than once per event loop iteration.</p> |
495 | </dd> |
523 | </dd> |
496 | <dt>ev_timer_again (loop)</dt> |
524 | <dt>ev_timer_again (loop)</dt> |
497 | <dd> |
525 | <dd> |
498 | <p>This will act as if the timer timed out and restart it again if it is |
526 | <p>This will act as if the timer timed out and restart it again if it is |
… | |
… | |
524 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
552 | take a year to trigger the event (unlike an <code>ev_timer</code>, which would trigger |
525 | roughly 10 seconds later and of course not if you reset your system time |
553 | roughly 10 seconds later and of course not if you reset your system time |
526 | again).</p> |
554 | again).</p> |
527 | <p>They can also be used to implement vastly more complex timers, such as |
555 | <p>They can also be used to implement vastly more complex timers, such as |
528 | triggering an event on eahc midnight, local time.</p> |
556 | triggering an event on eahc midnight, local time.</p> |
|
|
557 | <p>As with timers, the callback is guarenteed to be invoked only when the |
|
|
558 | time (<code>at</code>) has been passed, but if multiple periodic timers become ready |
|
|
559 | during the same loop iteration then order of execution is undefined.</p> |
529 | <dl> |
560 | <dl> |
530 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
561 | <dt>ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)</dt> |
531 | <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> |
562 | <dt>ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)</dt> |
532 | <dd> |
563 | <dd> |
533 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
564 | <p>Lots of arguments, lets sort it out... There are basically three modes of |
534 | operation, and we will explain them from simplest to complex:</p> |
565 | operation, and we will explain them from simplest to complex:</p> |
535 | |
|
|
536 | |
|
|
537 | |
|
|
538 | |
|
|
539 | <p> |
566 | <p> |
540 | <dl> |
567 | <dl> |
541 | <dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
568 | <dt>* absolute timer (interval = reschedule_cb = 0)</dt> |
542 | <dd> |
569 | <dd> |
543 | <p>In this configuration the watcher triggers an event at the wallclock time |
570 | <p>In this configuration the watcher triggers an event at the wallclock time |
… | |
… | |
567 | <dd> |
594 | <dd> |
568 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
595 | <p>In this mode the values for <code>interval</code> and <code>at</code> are both being |
569 | ignored. Instead, each time the periodic watcher gets scheduled, the |
596 | ignored. Instead, each time the periodic watcher gets scheduled, the |
570 | reschedule callback will be called with the watcher as first, and the |
597 | reschedule callback will be called with the watcher as first, and the |
571 | current time as second argument.</p> |
598 | current time as second argument.</p> |
572 | <p>NOTE: <i>This callback MUST NOT stop or destroy the periodic or any other |
599 | <p>NOTE: <i>This callback MUST NOT stop or destroy any periodic watcher, |
573 | periodic watcher, ever, or make any event loop modifications</i>. If you need |
600 | ever, or make any event loop modifications</i>. If you need to stop it, |
574 | to stop it, return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards.</p> |
601 | return <code>now + 1e30</code> (or so, fudge fudge) and stop it afterwards (e.g. by |
575 | <p>Also, <i>this callback must always return a time that is later than the |
602 | starting a prepare watcher).</p> |
576 | passed <code>now</code> value</i>. Not even <code>now</code> itself will be ok.</p> |
|
|
577 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
603 | <p>Its prototype is <code>ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
578 | ev_tstamp now)</code>, e.g.:</p> |
604 | ev_tstamp now)</code>, e.g.:</p> |
579 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
605 | <pre> static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
580 | { |
606 | { |
581 | return now + 60.; |
607 | return now + 60.; |
… | |
… | |
584 | </pre> |
610 | </pre> |
585 | <p>It must return the next time to trigger, based on the passed time value |
611 | <p>It must return the next time to trigger, based on the passed time value |
586 | (that is, the lowest time value larger than to the second argument). It |
612 | (that is, the lowest time value larger than to the second argument). It |
587 | will usually be called just before the callback will be triggered, but |
613 | will usually be called just before the callback will be triggered, but |
588 | might be called at other times, too.</p> |
614 | might be called at other times, too.</p> |
|
|
615 | <p>NOTE: <i>This callback must always return a time that is later than the |
|
|
616 | passed <code>now</code> value</i>. Not even <code>now</code> itself will do, it <i>must</i> be larger.</p> |
589 | <p>This can be used to create very complex timers, such as a timer that |
617 | <p>This can be used to create very complex timers, such as a timer that |
590 | triggers on each midnight, local time. To do this, you would calculate the |
618 | triggers on each midnight, local time. To do this, you would calculate the |
591 | next midnight after <code>now</code> and return the timestamp value for this. How you do this |
619 | next midnight after <code>now</code> and return the timestamp value for this. How |
592 | is, again, up to you (but it is not trivial).</p> |
620 | you do this is, again, up to you (but it is not trivial, which is the main |
|
|
621 | reason I omitted it as an example).</p> |
593 | </dd> |
622 | </dd> |
594 | </dl> |
623 | </dl> |
595 | </p> |
624 | </p> |
596 | </dd> |
625 | </dd> |
597 | <dt>ev_periodic_again (loop, ev_periodic *)</dt> |
626 | <dt>ev_periodic_again (loop, ev_periodic *)</dt> |
… | |
… | |
670 | |
699 | |
671 | </div> |
700 | </div> |
672 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
701 | <h2 id="code_ev_prepare_code_and_code_ev_che"><code>ev_prepare</code> and <code>ev_check</code> - customise your event loop</h2> |
673 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
702 | <div id="code_ev_prepare_code_and_code_ev_che-2"> |
674 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
703 | <p>Prepare and check watchers are usually (but not always) used in tandem: |
675 | Prepare watchers get invoked before the process blocks and check watchers |
704 | prepare watchers get invoked before the process blocks and check watchers |
676 | afterwards.</p> |
705 | afterwards.</p> |
677 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
706 | <p>Their main purpose is to integrate other event mechanisms into libev. This |
678 | could be used, for example, to track variable changes, implement your own |
707 | could be used, for example, to track variable changes, implement your own |
679 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
708 | watchers, integrate net-snmp or a coroutine library and lots more.</p> |
680 | <p>This is done by examining in each prepare call which file descriptors need |
709 | <p>This is done by examining in each prepare call which file descriptors need |
681 | to be watched by the other library, registering <code>ev_io</code> watchers for |
710 | to be watched by the other library, registering <code>ev_io</code> watchers for |
682 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
711 | them and starting an <code>ev_timer</code> watcher for any timeouts (many libraries |
683 | provide just this functionality). Then, in the check watcher you check for |
712 | provide just this functionality). Then, in the check watcher you check for |
684 | any events that occured (by checking the pending status of all watchers |
713 | any events that occured (by checking the pending status of all watchers |
685 | and stopping them) and call back into the library. The I/O and timer |
714 | and stopping them) and call back into the library. The I/O and timer |
686 | callbacks will never actually be called (but must be valid neverthelles, |
715 | callbacks will never actually be called (but must be valid nevertheless, |
687 | because you never know, you know?).</p> |
716 | because you never know, you know?).</p> |
688 | <p>As another example, the Perl Coro module uses these hooks to integrate |
717 | <p>As another example, the Perl Coro module uses these hooks to integrate |
689 | coroutines into libev programs, by yielding to other active coroutines |
718 | coroutines into libev programs, by yielding to other active coroutines |
690 | during each prepare and only letting the process block if no coroutines |
719 | during each prepare and only letting the process block if no coroutines |
691 | are ready to run (its actually more complicated, it only runs coroutines |
720 | are ready to run (it's actually more complicated: it only runs coroutines |
692 | with priority higher than the event loop and one lower priority once, |
721 | with priority higher than or equal to the event loop and one coroutine |
693 | using idle watchers to keep the event loop from blocking if lower-priority |
722 | of lower priority, but only once, using idle watchers to keep the event |
694 | coroutines exist, thus mapping low-priority coroutines to idle/background |
723 | loop from blocking if lower-priority coroutines are active, thus mapping |
695 | tasks).</p> |
724 | low-priority coroutines to idle/background tasks).</p> |
696 | <dl> |
725 | <dl> |
697 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
726 | <dt>ev_prepare_init (ev_prepare *, callback)</dt> |
698 | <dt>ev_check_init (ev_check *, callback)</dt> |
727 | <dt>ev_check_init (ev_check *, callback)</dt> |
699 | <dd> |
728 | <dd> |
700 | <p>Initialises and configures the prepare or check watcher - they have no |
729 | <p>Initialises and configures the prepare or check watcher - they have no |
… | |
… | |
711 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
740 | <dt>ev_once (loop, int fd, int events, ev_tstamp timeout, callback)</dt> |
712 | <dd> |
741 | <dd> |
713 | <p>This function combines a simple timer and an I/O watcher, calls your |
742 | <p>This function combines a simple timer and an I/O watcher, calls your |
714 | callback on whichever event happens first and automatically stop both |
743 | callback on whichever event happens first and automatically stop both |
715 | watchers. This is useful if you want to wait for a single event on an fd |
744 | watchers. This is useful if you want to wait for a single event on an fd |
716 | or timeout without havign to allocate/configure/start/stop/free one or |
745 | or timeout without having to allocate/configure/start/stop/free one or |
717 | more watchers yourself.</p> |
746 | more watchers yourself.</p> |
718 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
747 | <p>If <code>fd</code> is less than 0, then no I/O watcher will be started and events |
719 | is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
748 | is being ignored. Otherwise, an <code>ev_io</code> watcher for the given <code>fd</code> and |
720 | <code>events</code> set will be craeted and started.</p> |
749 | <code>events</code> set will be craeted and started.</p> |
721 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
750 | <p>If <code>timeout</code> is less than 0, then no timeout watcher will be |
722 | started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
751 | started. Otherwise an <code>ev_timer</code> watcher with after = <code>timeout</code> (and |
723 | repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
752 | repeat = 0) will be started. While <code>0</code> is a valid timeout, it is of |
724 | dubious value.</p> |
753 | dubious value.</p> |
725 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
754 | <p>The callback has the type <code>void (*cb)(int revents, void *arg)</code> and gets |
726 | passed an events set like normal event callbacks (with a combination of |
755 | passed an <code>revents</code> set like normal event callbacks (a combination of |
727 | <code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
756 | <code>EV_ERROR</code>, <code>EV_READ</code>, <code>EV_WRITE</code> or <code>EV_TIMEOUT</code>) and the <code>arg</code> |
728 | value passed to <code>ev_once</code>:</p> |
757 | value passed to <code>ev_once</code>:</p> |
729 | <pre> static void stdin_ready (int revents, void *arg) |
758 | <pre> static void stdin_ready (int revents, void *arg) |
730 | { |
759 | { |
731 | if (revents & EV_TIMEOUT) |
760 | if (revents & EV_TIMEOUT) |
… | |
… | |
754 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
783 | <p>Feed an event as if the given signal occured (loop must be the default loop!).</p> |
755 | </dd> |
784 | </dd> |
756 | </dl> |
785 | </dl> |
757 | |
786 | |
758 | </div> |
787 | </div> |
|
|
788 | <h1 id="LIBEVENT_EMULATION">LIBEVENT EMULATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
789 | <div id="LIBEVENT_EMULATION_CONTENT"> |
|
|
790 | <p>Libev offers a compatibility emulation layer for libevent. It cannot |
|
|
791 | emulate the internals of libevent, so here are some usage hints:</p> |
|
|
792 | <dl> |
|
|
793 | <dt>* Use it by including <event.h>, as usual.</dt> |
|
|
794 | <dt>* The following members are fully supported: ev_base, ev_callback, |
|
|
795 | ev_arg, ev_fd, ev_res, ev_events.</dt> |
|
|
796 | <dt>* Avoid using ev_flags and the EVLIST_*-macros, while it is |
|
|
797 | maintained by libev, it does not work exactly the same way as in libevent (consider |
|
|
798 | it a private API).</dt> |
|
|
799 | <dt>* Priorities are not currently supported. Initialising priorities |
|
|
800 | will fail and all watchers will have the same priority, even though there |
|
|
801 | is an ev_pri field.</dt> |
|
|
802 | <dt>* Other members are not supported.</dt> |
|
|
803 | <dt>* The libev emulation is <i>not</i> ABI compatible to libevent, you need |
|
|
804 | to use the libev header file and library.</dt> |
|
|
805 | </dl> |
|
|
806 | |
|
|
807 | </div> |
|
|
808 | <h1 id="C_SUPPORT">C++ SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
|
|
809 | <div id="C_SUPPORT_CONTENT"> |
|
|
810 | <p>TBD.</p> |
|
|
811 | |
|
|
812 | </div> |
759 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
813 | <h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
760 | <div id="AUTHOR_CONTENT"> |
814 | <div id="AUTHOR_CONTENT"> |
761 | <p>Marc Lehmann <libev@schmorp.de>.</p> |
815 | <p>Marc Lehmann <libev@schmorp.de>.</p> |
762 | |
816 | |
763 | </div> |
817 | </div> |