… | |
… | |
39 | F<README.embed> in the libev distribution. If libev was configured without |
39 | F<README.embed> in the libev distribution. If libev was configured without |
40 | support for multiple event loops, then all functions taking an initial |
40 | support for multiple event loops, then all functions taking an initial |
41 | argument of name C<loop> (which is always of type C<struct ev_loop *>) |
41 | argument of name C<loop> (which is always of type C<struct ev_loop *>) |
42 | will not have this argument. |
42 | will not have this argument. |
43 | |
43 | |
44 | =head1 TIME AND OTHER GLOBAL FUNCTIONS |
44 | =head1 TIME REPRESENTATION |
45 | |
45 | |
46 | Libev represents time as a single floating point number, representing the |
46 | Libev represents time as a single floating point number, representing the |
47 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
47 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
48 | the beginning of 1970, details are complicated, don't ask). This type is |
48 | the beginning of 1970, details are complicated, don't ask). This type is |
49 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
49 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
50 | to the double type in C. |
50 | to the double type in C. |
51 | |
51 | |
|
|
52 | =head1 GLOBAL FUNCTIONS |
|
|
53 | |
|
|
54 | These functions can be called anytime, even before initialising the |
|
|
55 | library in any way. |
|
|
56 | |
52 | =over 4 |
57 | =over 4 |
53 | |
58 | |
54 | =item ev_tstamp ev_time () |
59 | =item ev_tstamp ev_time () |
55 | |
60 | |
56 | Returns the current time as libev would use it. |
61 | Returns the current time as libev would use it. Please note that the |
|
|
62 | C<ev_now> function is usually faster and also often returns the timestamp |
|
|
63 | you actually want to know. |
57 | |
64 | |
58 | =item int ev_version_major () |
65 | =item int ev_version_major () |
59 | |
66 | |
60 | =item int ev_version_minor () |
67 | =item int ev_version_minor () |
61 | |
68 | |
… | |
… | |
99 | An event loop is described by a C<struct ev_loop *>. The library knows two |
106 | An event loop is described by a C<struct ev_loop *>. The library knows two |
100 | types of such loops, the I<default> loop, which supports signals and child |
107 | types of such loops, the I<default> loop, which supports signals and child |
101 | events, and dynamically created loops which do not. |
108 | events, and dynamically created loops which do not. |
102 | |
109 | |
103 | If you use threads, a common model is to run the default event loop |
110 | If you use threads, a common model is to run the default event loop |
104 | in your main thread (or in a separate thrad) and for each thread you |
111 | in your main thread (or in a separate thread) and for each thread you |
105 | create, you also create another event loop. Libev itself does no locking |
112 | create, you also create another event loop. Libev itself does no locking |
106 | whatsoever, so if you mix calls to the same event loop in different |
113 | whatsoever, so if you mix calls to the same event loop in different |
107 | threads, make sure you lock (this is usually a bad idea, though, even if |
114 | threads, make sure you lock (this is usually a bad idea, though, even if |
108 | done correctly, because it's hideous and inefficient). |
115 | done correctly, because it's hideous and inefficient). |
109 | |
116 | |
… | |
… | |
232 | |
239 | |
233 | This flags value could be used to implement alternative looping |
240 | This flags value could be used to implement alternative looping |
234 | constructs, but the C<prepare> and C<check> watchers provide a better and |
241 | constructs, but the C<prepare> and C<check> watchers provide a better and |
235 | more generic mechanism. |
242 | more generic mechanism. |
236 | |
243 | |
|
|
244 | Here are the gory details of what ev_loop does: |
|
|
245 | |
|
|
246 | 1. If there are no active watchers (reference count is zero), return. |
|
|
247 | 2. Queue and immediately call all prepare watchers. |
|
|
248 | 3. If we have been forked, recreate the kernel state. |
|
|
249 | 4. Update the kernel state with all outstanding changes. |
|
|
250 | 5. Update the "event loop time". |
|
|
251 | 6. Calculate for how long to block. |
|
|
252 | 7. Block the process, waiting for events. |
|
|
253 | 8. Update the "event loop time" and do time jump handling. |
|
|
254 | 9. Queue all outstanding timers. |
|
|
255 | 10. Queue all outstanding periodics. |
|
|
256 | 11. If no events are pending now, queue all idle watchers. |
|
|
257 | 12. Queue all check watchers. |
|
|
258 | 13. Call all queued watchers in reverse order (i.e. check watchers first). |
|
|
259 | 14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
|
|
260 | was used, return, otherwise continue with step #1. |
|
|
261 | |
237 | =item ev_unloop (loop, how) |
262 | =item ev_unloop (loop, how) |
238 | |
263 | |
239 | Can be used to make a call to C<ev_loop> return early (but only after it |
264 | Can be used to make a call to C<ev_loop> return early (but only after it |
240 | has processed all outstanding events). The C<how> argument must be either |
265 | has processed all outstanding events). The C<how> argument must be either |
241 | C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> call return, or |
266 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
242 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
267 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
243 | |
268 | |
244 | =item ev_ref (loop) |
269 | =item ev_ref (loop) |
245 | |
270 | |
246 | =item ev_unref (loop) |
271 | =item ev_unref (loop) |
… | |
… | |
299 | |
324 | |
300 | As long as your watcher is active (has been started but not stopped) you |
325 | As long as your watcher is active (has been started but not stopped) you |
301 | must not touch the values stored in it. Most specifically you must never |
326 | must not touch the values stored in it. Most specifically you must never |
302 | reinitialise it or call its set method. |
327 | reinitialise it or call its set method. |
303 | |
328 | |
304 | You cna check whether an event is active by calling the C<ev_is_active |
329 | You can check whether an event is active by calling the C<ev_is_active |
305 | (watcher *)> macro. To see whether an event is outstanding (but the |
330 | (watcher *)> macro. To see whether an event is outstanding (but the |
306 | callback for it has not been called yet) you cna use the C<ev_is_pending |
331 | callback for it has not been called yet) you can use the C<ev_is_pending |
307 | (watcher *)> macro. |
332 | (watcher *)> macro. |
308 | |
333 | |
309 | Each and every callback receives the event loop pointer as first, the |
334 | Each and every callback receives the event loop pointer as first, the |
310 | registered watcher structure as second, and a bitset of received events as |
335 | registered watcher structure as second, and a bitset of received events as |
311 | third argument. |
336 | third argument. |
312 | |
337 | |
313 | The rceeived events usually include a single bit per event type received |
338 | The received events usually include a single bit per event type received |
314 | (you can receive multiple events at the same time). The possible bit masks |
339 | (you can receive multiple events at the same time). The possible bit masks |
315 | are: |
340 | are: |
316 | |
341 | |
317 | =over 4 |
342 | =over 4 |
318 | |
343 | |
… | |
… | |
372 | =back |
397 | =back |
373 | |
398 | |
374 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
399 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
375 | |
400 | |
376 | Each watcher has, by default, a member C<void *data> that you can change |
401 | Each watcher has, by default, a member C<void *data> that you can change |
377 | and read at any time, libev will completely ignore it. This cna be used |
402 | and read at any time, libev will completely ignore it. This can be used |
378 | to associate arbitrary data with your watcher. If you need more data and |
403 | to associate arbitrary data with your watcher. If you need more data and |
379 | don't want to allocate memory and store a pointer to it in that data |
404 | don't want to allocate memory and store a pointer to it in that data |
380 | member, you can also "subclass" the watcher type and provide your own |
405 | member, you can also "subclass" the watcher type and provide your own |
381 | data: |
406 | data: |
382 | |
407 | |
… | |
… | |
409 | =head2 C<ev_io> - is this file descriptor readable or writable |
434 | =head2 C<ev_io> - is this file descriptor readable or writable |
410 | |
435 | |
411 | I/O watchers check whether a file descriptor is readable or writable |
436 | I/O watchers check whether a file descriptor is readable or writable |
412 | in each iteration of the event loop (This behaviour is called |
437 | in each iteration of the event loop (This behaviour is called |
413 | level-triggering because you keep receiving events as long as the |
438 | level-triggering because you keep receiving events as long as the |
414 | condition persists. Remember you cna stop the watcher if you don't want to |
439 | condition persists. Remember you can stop the watcher if you don't want to |
415 | act on the event and neither want to receive future events). |
440 | act on the event and neither want to receive future events). |
416 | |
441 | |
417 | In general you can register as many read and/or write event watchers oer |
442 | In general you can register as many read and/or write event watchers per |
418 | fd as you want (as long as you don't confuse yourself). Setting all file |
443 | fd as you want (as long as you don't confuse yourself). Setting all file |
419 | descriptors to non-blocking mode is also usually a good idea (but not |
444 | descriptors to non-blocking mode is also usually a good idea (but not |
420 | required if you know what you are doing). |
445 | required if you know what you are doing). |
421 | |
446 | |
422 | You have to be careful with dup'ed file descriptors, though. Some backends |
447 | You have to be careful with dup'ed file descriptors, though. Some backends |
423 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
448 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
424 | descriptors correctly if you register interest in two or more fds pointing |
449 | descriptors correctly if you register interest in two or more fds pointing |
425 | to the same file/socket etc. description. |
450 | to the same underlying file/socket etc. description (that is, they share |
|
|
451 | the same underlying "file open"). |
426 | |
452 | |
427 | If you must do this, then force the use of a known-to-be-good backend |
453 | If you must do this, then force the use of a known-to-be-good backend |
428 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
454 | (at the time of this writing, this includes only EVMETHOD_SELECT and |
429 | EVMETHOD_POLL). |
455 | EVMETHOD_POLL). |
430 | |
456 | |
… | |
… | |
444 | |
470 | |
445 | Timer watchers are simple relative timers that generate an event after a |
471 | Timer watchers are simple relative timers that generate an event after a |
446 | given time, and optionally repeating in regular intervals after that. |
472 | given time, and optionally repeating in regular intervals after that. |
447 | |
473 | |
448 | The timers are based on real time, that is, if you register an event that |
474 | The timers are based on real time, that is, if you register an event that |
449 | times out after an hour and youreset your system clock to last years |
475 | times out after an hour and you reset your system clock to last years |
450 | time, it will still time out after (roughly) and hour. "Roughly" because |
476 | time, it will still time out after (roughly) and hour. "Roughly" because |
451 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
477 | detecting time jumps is hard, and soem inaccuracies are unavoidable (the |
452 | monotonic clock option helps a lot here). |
478 | monotonic clock option helps a lot here). |
453 | |
479 | |
454 | The relative timeouts are calculated relative to the C<ev_now ()> |
480 | The relative timeouts are calculated relative to the C<ev_now ()> |
455 | time. This is usually the right thing as this timestamp refers to the time |
481 | time. This is usually the right thing as this timestamp refers to the time |
456 | of the event triggering whatever timeout you are modifying/starting. If |
482 | of the event triggering whatever timeout you are modifying/starting. If |
457 | you suspect event processing to be delayed and you *need* to base the timeout |
483 | you suspect event processing to be delayed and you *need* to base the timeout |
458 | ion the current time, use something like this to adjust for this: |
484 | on the current time, use something like this to adjust for this: |
459 | |
485 | |
460 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
486 | ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); |
461 | |
487 | |
462 | =over 4 |
488 | =over 4 |
463 | |
489 | |
… | |
… | |
471 | later, again, and again, until stopped manually. |
497 | later, again, and again, until stopped manually. |
472 | |
498 | |
473 | The timer itself will do a best-effort at avoiding drift, that is, if you |
499 | The timer itself will do a best-effort at avoiding drift, that is, if you |
474 | configure a timer to trigger every 10 seconds, then it will trigger at |
500 | configure a timer to trigger every 10 seconds, then it will trigger at |
475 | exactly 10 second intervals. If, however, your program cannot keep up with |
501 | exactly 10 second intervals. If, however, your program cannot keep up with |
476 | the timer (ecause it takes longer than those 10 seconds to do stuff) the |
502 | the timer (because it takes longer than those 10 seconds to do stuff) the |
477 | timer will not fire more than once per event loop iteration. |
503 | timer will not fire more than once per event loop iteration. |
478 | |
504 | |
479 | =item ev_timer_again (loop) |
505 | =item ev_timer_again (loop) |
480 | |
506 | |
481 | This will act as if the timer timed out and restart it again if it is |
507 | This will act as if the timer timed out and restart it again if it is |
… | |
… | |
495 | state where you do not expect data to travel on the socket, you can stop |
521 | state where you do not expect data to travel on the socket, you can stop |
496 | the timer, and again will automatically restart it if need be. |
522 | the timer, and again will automatically restart it if need be. |
497 | |
523 | |
498 | =back |
524 | =back |
499 | |
525 | |
500 | =head2 C<ev_periodic> - to cron or not to cron it |
526 | =head2 C<ev_periodic> - to cron or not to cron |
501 | |
527 | |
502 | Periodic watchers are also timers of a kind, but they are very versatile |
528 | Periodic watchers are also timers of a kind, but they are very versatile |
503 | (and unfortunately a bit complex). |
529 | (and unfortunately a bit complex). |
504 | |
530 | |
505 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
531 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
… | |
… | |
544 | |
570 | |
545 | ev_periodic_set (&periodic, 0., 3600., 0); |
571 | ev_periodic_set (&periodic, 0., 3600., 0); |
546 | |
572 | |
547 | This doesn't mean there will always be 3600 seconds in between triggers, |
573 | This doesn't mean there will always be 3600 seconds in between triggers, |
548 | but only that the the callback will be called when the system time shows a |
574 | but only that the the callback will be called when the system time shows a |
549 | full hour (UTC), or more correct, when the system time is evenly divisible |
575 | full hour (UTC), or more correctly, when the system time is evenly divisible |
550 | by 3600. |
576 | by 3600. |
551 | |
577 | |
552 | Another way to think about it (for the mathematically inclined) is that |
578 | Another way to think about it (for the mathematically inclined) is that |
553 | C<ev_periodic> will try to run the callback in this mode at the next possible |
579 | C<ev_periodic> will try to run the callback in this mode at the next possible |
554 | time where C<time = at (mod interval)>, regardless of any time jumps. |
580 | time where C<time = at (mod interval)>, regardless of any time jumps. |
… | |
… | |
558 | In this mode the values for C<interval> and C<at> are both being |
584 | In this mode the values for C<interval> and C<at> are both being |
559 | ignored. Instead, each time the periodic watcher gets scheduled, the |
585 | ignored. Instead, each time the periodic watcher gets scheduled, the |
560 | reschedule callback will be called with the watcher as first, and the |
586 | reschedule callback will be called with the watcher as first, and the |
561 | current time as second argument. |
587 | current time as second argument. |
562 | |
588 | |
563 | NOTE: I<This callback MUST NOT stop or destroy the periodic or any other |
589 | NOTE: I<This callback MUST NOT stop or destroy any periodic watcher, |
564 | periodic watcher, ever, or make any event loop modificstions>. If you need |
590 | ever, or make any event loop modifications>. If you need to stop it, |
565 | to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards. |
591 | return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by |
|
|
592 | starting a prepare watcher). |
566 | |
593 | |
567 | Its prototype is c<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
594 | Its prototype is C<ev_tstamp (*reschedule_cb)(struct ev_periodic *w, |
568 | ev_tstamp now)>, e.g.: |
595 | ev_tstamp now)>, e.g.: |
569 | |
596 | |
570 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
597 | static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now) |
571 | { |
598 | { |
572 | return now + 60.; |
599 | return now + 60.; |
… | |
… | |
575 | It must return the next time to trigger, based on the passed time value |
602 | It must return the next time to trigger, based on the passed time value |
576 | (that is, the lowest time value larger than to the second argument). It |
603 | (that is, the lowest time value larger than to the second argument). It |
577 | will usually be called just before the callback will be triggered, but |
604 | will usually be called just before the callback will be triggered, but |
578 | might be called at other times, too. |
605 | might be called at other times, too. |
579 | |
606 | |
|
|
607 | NOTE: I<< This callback must always return a time that is later than the |
|
|
608 | passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger. |
|
|
609 | |
580 | This can be used to create very complex timers, such as a timer that |
610 | This can be used to create very complex timers, such as a timer that |
581 | triggers on each midnight, local time. To do this, you would calculate the |
611 | triggers on each midnight, local time. To do this, you would calculate the |
582 | next midnight after C<now> and return the timestamp value for this. How you do this |
612 | next midnight after C<now> and return the timestamp value for this. How |
583 | is, again, up to you (but it is not trivial). |
613 | you do this is, again, up to you (but it is not trivial, which is the main |
|
|
614 | reason I omitted it as an example). |
584 | |
615 | |
585 | =back |
616 | =back |
586 | |
617 | |
587 | =item ev_periodic_again (loop, ev_periodic *) |
618 | =item ev_periodic_again (loop, ev_periodic *) |
588 | |
619 | |
… | |
… | |
598 | Signal watchers will trigger an event when the process receives a specific |
629 | Signal watchers will trigger an event when the process receives a specific |
599 | signal one or more times. Even though signals are very asynchronous, libev |
630 | signal one or more times. Even though signals are very asynchronous, libev |
600 | will try it's best to deliver signals synchronously, i.e. as part of the |
631 | will try it's best to deliver signals synchronously, i.e. as part of the |
601 | normal event processing, like any other event. |
632 | normal event processing, like any other event. |
602 | |
633 | |
603 | You cna configure as many watchers as you like per signal. Only when the |
634 | You can configure as many watchers as you like per signal. Only when the |
604 | first watcher gets started will libev actually register a signal watcher |
635 | first watcher gets started will libev actually register a signal watcher |
605 | with the kernel (thus it coexists with your own signal handlers as long |
636 | with the kernel (thus it coexists with your own signal handlers as long |
606 | as you don't register any with libev). Similarly, when the last signal |
637 | as you don't register any with libev). Similarly, when the last signal |
607 | watcher for a signal is stopped libev will reset the signal handler to |
638 | watcher for a signal is stopped libev will reset the signal handler to |
608 | SIG_DFL (regardless of what it was set to before). |
639 | SIG_DFL (regardless of what it was set to before). |
… | |
… | |
630 | =item ev_child_set (ev_child *, int pid) |
661 | =item ev_child_set (ev_child *, int pid) |
631 | |
662 | |
632 | Configures the watcher to wait for status changes of process C<pid> (or |
663 | Configures the watcher to wait for status changes of process C<pid> (or |
633 | I<any> process if C<pid> is specified as C<0>). The callback can look |
664 | I<any> process if C<pid> is specified as C<0>). The callback can look |
634 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
665 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
635 | the status word (use the macros from C<sys/wait.h>). The C<rpid> member |
666 | the status word (use the macros from C<sys/wait.h> and see your systems |
636 | contains the pid of the process causing the status change. |
667 | C<waitpid> documentation). The C<rpid> member contains the pid of the |
|
|
668 | process causing the status change. |
637 | |
669 | |
638 | =back |
670 | =back |
639 | |
671 | |
640 | =head2 C<ev_idle> - when you've got nothing better to do |
672 | =head2 C<ev_idle> - when you've got nothing better to do |
641 | |
673 | |
642 | Idle watchers trigger events when there are no other I/O or timer (or |
674 | Idle watchers trigger events when there are no other events are pending |
643 | periodic) events pending. That is, as long as your process is busy |
675 | (prepare, check and other idle watchers do not count). That is, as long |
644 | handling sockets or timeouts it will not be called. But when your process |
676 | as your process is busy handling sockets or timeouts (or even signals, |
645 | is idle all idle watchers are being called again and again - until |
677 | imagine) it will not be triggered. But when your process is idle all idle |
|
|
678 | watchers are being called again and again, once per event loop iteration - |
646 | stopped, that is, or your process receives more events. |
679 | until stopped, that is, or your process receives more events and becomes |
|
|
680 | busy. |
647 | |
681 | |
648 | The most noteworthy effect is that as long as any idle watchers are |
682 | The most noteworthy effect is that as long as any idle watchers are |
649 | active, the process will not block when waiting for new events. |
683 | active, the process will not block when waiting for new events. |
650 | |
684 | |
651 | Apart from keeping your process non-blocking (which is a useful |
685 | Apart from keeping your process non-blocking (which is a useful |
… | |
… | |
661 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
695 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
662 | believe me. |
696 | believe me. |
663 | |
697 | |
664 | =back |
698 | =back |
665 | |
699 | |
666 | =head2 prepare and check - your hooks into the event loop |
700 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop |
667 | |
701 | |
668 | Prepare and check watchers usually (but not always) are used in |
702 | Prepare and check watchers are usually (but not always) used in tandem: |
669 | tandom. Prepare watchers get invoked before the process blocks and check |
703 | prepare watchers get invoked before the process blocks and check watchers |
670 | watchers afterwards. |
704 | afterwards. |
671 | |
705 | |
672 | Their main purpose is to integrate other event mechanisms into libev. This |
706 | Their main purpose is to integrate other event mechanisms into libev. This |
673 | 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 |
674 | watchers, integrate net-snmp or a coroutine library and lots more. |
708 | watchers, integrate net-snmp or a coroutine library and lots more. |
675 | |
709 | |
676 | This is done by examining in each prepare call which file descriptors need |
710 | This is done by examining in each prepare call which file descriptors need |
677 | to be watched by the other library, registering C<ev_io> watchers for them |
711 | to be watched by the other library, registering C<ev_io> watchers for |
678 | and starting an C<ev_timer> watcher for any timeouts (many libraries provide |
712 | them and starting an C<ev_timer> watcher for any timeouts (many libraries |
679 | just this functionality). Then, in the check watcher you check for any |
713 | provide just this functionality). Then, in the check watcher you check for |
680 | events that occured (by making your callbacks set soem flags for example) |
714 | any events that occured (by checking the pending status of all watchers |
681 | and call back into the library. |
715 | and stopping them) and call back into the library. The I/O and timer |
|
|
716 | callbacks will never actually be called (but must be valid nevertheless, |
|
|
717 | because you never know, you know?). |
682 | |
718 | |
683 | As another example, the perl Coro module uses these hooks to integrate |
719 | As another example, the Perl Coro module uses these hooks to integrate |
684 | coroutines into libev programs, by yielding to other active coroutines |
720 | coroutines into libev programs, by yielding to other active coroutines |
685 | during each prepare and only letting the process block if no coroutines |
721 | during each prepare and only letting the process block if no coroutines |
686 | are ready to run. |
722 | are ready to run (it's actually more complicated: it only runs coroutines |
|
|
723 | with priority higher than or equal to the event loop and one coroutine |
|
|
724 | of lower priority, but only once, using idle watchers to keep the event |
|
|
725 | loop from blocking if lower-priority coroutines are active, thus mapping |
|
|
726 | low-priority coroutines to idle/background tasks). |
687 | |
727 | |
688 | =over 4 |
728 | =over 4 |
689 | |
729 | |
690 | =item ev_prepare_init (ev_prepare *, callback) |
730 | =item ev_prepare_init (ev_prepare *, callback) |
691 | |
731 | |
692 | =item ev_check_init (ev_check *, callback) |
732 | =item ev_check_init (ev_check *, callback) |
693 | |
733 | |
694 | Initialises and configures the prepare or check watcher - they have no |
734 | Initialises and configures the prepare or check watcher - they have no |
695 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
735 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
696 | macros, but using them is utterly, utterly pointless. |
736 | macros, but using them is utterly, utterly and completely pointless. |
697 | |
737 | |
698 | =back |
738 | =back |
699 | |
739 | |
700 | =head1 OTHER FUNCTIONS |
740 | =head1 OTHER FUNCTIONS |
701 | |
741 | |
702 | There are some other fucntions of possible interest. Described. Here. Now. |
742 | There are some other functions of possible interest. Described. Here. Now. |
703 | |
743 | |
704 | =over 4 |
744 | =over 4 |
705 | |
745 | |
706 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
746 | =item ev_once (loop, int fd, int events, ev_tstamp timeout, callback) |
707 | |
747 | |
708 | This function combines a simple timer and an I/O watcher, calls your |
748 | This function combines a simple timer and an I/O watcher, calls your |
709 | callback on whichever event happens first and automatically stop both |
749 | callback on whichever event happens first and automatically stop both |
710 | watchers. This is useful if you want to wait for a single event on an fd |
750 | watchers. This is useful if you want to wait for a single event on an fd |
711 | or timeout without havign to allocate/configure/start/stop/free one or |
751 | or timeout without having to allocate/configure/start/stop/free one or |
712 | more watchers yourself. |
752 | more watchers yourself. |
713 | |
753 | |
714 | If C<fd> is less than 0, then no I/O watcher will be started and events is |
754 | If C<fd> is less than 0, then no I/O watcher will be started and events |
715 | ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and C<events> set |
755 | is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and |
716 | will be craeted and started. |
756 | C<events> set will be craeted and started. |
717 | |
757 | |
718 | If C<timeout> is less than 0, then no timeout watcher will be |
758 | If C<timeout> is less than 0, then no timeout watcher will be |
719 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and repeat |
759 | started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and |
720 | = 0) will be started. |
760 | repeat = 0) will be started. While C<0> is a valid timeout, it is of |
|
|
761 | dubious value. |
721 | |
762 | |
722 | The callback has the type C<void (*cb)(int revents, void *arg)> and |
763 | The callback has the type C<void (*cb)(int revents, void *arg)> and gets |
723 | gets passed an events set (normally a combination of C<EV_ERROR>, C<EV_READ>, |
764 | passed an C<revents> set like normal event callbacks (a combination of |
724 | C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> value passed to C<ev_once>: |
765 | C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> |
|
|
766 | value passed to C<ev_once>: |
725 | |
767 | |
726 | static void stdin_ready (int revents, void *arg) |
768 | static void stdin_ready (int revents, void *arg) |
727 | { |
769 | { |
728 | if (revents & EV_TIMEOUT) |
770 | if (revents & EV_TIMEOUT) |
729 | /* doh, nothing entered */ |
771 | /* doh, nothing entered */; |
730 | else if (revents & EV_READ) |
772 | else if (revents & EV_READ) |
731 | /* stdin might have data for us, joy! */ |
773 | /* stdin might have data for us, joy! */; |
732 | } |
774 | } |
733 | |
775 | |
734 | ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0); |
776 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
735 | |
777 | |
736 | =item ev_feed_event (loop, watcher, int events) |
778 | =item ev_feed_event (loop, watcher, int events) |
737 | |
779 | |
738 | Feeds the given event set into the event loop, as if the specified event |
780 | Feeds the given event set into the event loop, as if the specified event |
739 | has happened for the specified watcher (which must be a pointer to an |
781 | had happened for the specified watcher (which must be a pointer to an |
740 | initialised but not necessarily active event watcher). |
782 | initialised but not necessarily started event watcher). |
741 | |
783 | |
742 | =item ev_feed_fd_event (loop, int fd, int revents) |
784 | =item ev_feed_fd_event (loop, int fd, int revents) |
743 | |
785 | |
744 | Feed an event on the given fd, as if a file descriptor backend detected it. |
786 | Feed an event on the given fd, as if a file descriptor backend detected |
|
|
787 | the given events it. |
745 | |
788 | |
746 | =item ev_feed_signal_event (loop, int signum) |
789 | =item ev_feed_signal_event (loop, int signum) |
747 | |
790 | |
748 | Feed an event as if the given signal occured (loop must be the default loop!). |
791 | Feed an event as if the given signal occured (loop must be the default loop!). |
749 | |
792 | |
750 | =back |
793 | =back |
751 | |
794 | |
|
|
795 | =head1 LIBEVENT EMULATION |
|
|
796 | |
|
|
797 | Libev offers a compatibility emulation layer for libevent. It cannot |
|
|
798 | emulate the internals of libevent, so here are some usage hints: |
|
|
799 | |
|
|
800 | =over 4 |
|
|
801 | |
|
|
802 | =item * Use it by including <event.h>, as usual. |
|
|
803 | |
|
|
804 | =item * The following members are fully supported: ev_base, ev_callback, |
|
|
805 | ev_arg, ev_fd, ev_res, ev_events. |
|
|
806 | |
|
|
807 | =item * Avoid using ev_flags and the EVLIST_*-macros, while it is |
|
|
808 | maintained by libev, it does not work exactly the same way as in libevent (consider |
|
|
809 | it a private API). |
|
|
810 | |
|
|
811 | =item * Priorities are not currently supported. Initialising priorities |
|
|
812 | will fail and all watchers will have the same priority, even though there |
|
|
813 | is an ev_pri field. |
|
|
814 | |
|
|
815 | =item * Other members are not supported. |
|
|
816 | |
|
|
817 | =item * The libev emulation is I<not> ABI compatible to libevent, you need |
|
|
818 | to use the libev header file and library. |
|
|
819 | |
|
|
820 | =back |
|
|
821 | |
|
|
822 | =head1 C++ SUPPORT |
|
|
823 | |
|
|
824 | TBD. |
|
|
825 | |
752 | =head1 AUTHOR |
826 | =head1 AUTHOR |
753 | |
827 | |
754 | Marc Lehmann <libev@schmorp.de>. |
828 | Marc Lehmann <libev@schmorp.de>. |
755 | |
829 | |