… | |
… | |
468 | ev_ref (myloop); |
468 | ev_ref (myloop); |
469 | ev_signal_stop (myloop, &exitsig); |
469 | ev_signal_stop (myloop, &exitsig); |
470 | |
470 | |
471 | =back |
471 | =back |
472 | |
472 | |
|
|
473 | |
473 | =head1 ANATOMY OF A WATCHER |
474 | =head1 ANATOMY OF A WATCHER |
474 | |
475 | |
475 | A watcher is a structure that you create and register to record your |
476 | A watcher is a structure that you create and register to record your |
476 | interest in some event. For instance, if you want to wait for STDIN to |
477 | interest in some event. For instance, if you want to wait for STDIN to |
477 | become readable, you would create an C<ev_io> watcher for that: |
478 | become readable, you would create an C<ev_io> watcher for that: |
… | |
… | |
576 | with the error from read() or write(). This will not work in multithreaded |
577 | with the error from read() or write(). This will not work in multithreaded |
577 | programs, though, so beware. |
578 | programs, though, so beware. |
578 | |
579 | |
579 | =back |
580 | =back |
580 | |
581 | |
581 | =head2 SUMMARY OF GENERIC WATCHER FUNCTIONS |
582 | =head2 GENERIC WATCHER FUNCTIONS |
582 | |
583 | |
583 | In the following description, C<TYPE> stands for the watcher type, |
584 | In the following description, C<TYPE> stands for the watcher type, |
584 | e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers. |
585 | e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers. |
585 | |
586 | |
586 | =over 4 |
587 | =over 4 |
… | |
… | |
595 | which rolls both calls into one. |
596 | which rolls both calls into one. |
596 | |
597 | |
597 | You can reinitialise a watcher at any time as long as it has been stopped |
598 | You can reinitialise a watcher at any time as long as it has been stopped |
598 | (or never started) and there are no pending events outstanding. |
599 | (or never started) and there are no pending events outstanding. |
599 | |
600 | |
600 | The callbakc is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, |
601 | The callback is always of type C<void (*)(ev_loop *loop, ev_TYPE *watcher, |
601 | int revents)>. |
602 | int revents)>. |
602 | |
603 | |
603 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
604 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
604 | |
605 | |
605 | This macro initialises the type-specific parts of a watcher. You need to |
606 | This macro initialises the type-specific parts of a watcher. You need to |
… | |
… | |
691 | |
692 | |
692 | This section describes each watcher in detail, but will not repeat |
693 | This section describes each watcher in detail, but will not repeat |
693 | information given in the last section. |
694 | information given in the last section. |
694 | |
695 | |
695 | |
696 | |
696 | =head2 C<ev_io> - is this file descriptor readable or writable |
697 | =head2 C<ev_io> - is this file descriptor readable or writable? |
697 | |
698 | |
698 | I/O watchers check whether a file descriptor is readable or writable |
699 | I/O watchers check whether a file descriptor is readable or writable |
699 | in each iteration of the event loop (This behaviour is called |
700 | in each iteration of the event loop, or, more precisely, when reading |
700 | level-triggering because you keep receiving events as long as the |
701 | would not block the process and writing would at least be able to write |
701 | condition persists. Remember you can stop the watcher if you don't want to |
702 | some data. This behaviour is called level-triggering because you keep |
702 | act on the event and neither want to receive future events). |
703 | receiving events as long as the condition persists. Remember you can stop |
|
|
704 | the watcher if you don't want to act on the event and neither want to |
|
|
705 | receive future events. |
703 | |
706 | |
704 | In general you can register as many read and/or write event watchers per |
707 | In general you can register as many read and/or write event watchers per |
705 | fd as you want (as long as you don't confuse yourself). Setting all file |
708 | fd as you want (as long as you don't confuse yourself). Setting all file |
706 | descriptors to non-blocking mode is also usually a good idea (but not |
709 | descriptors to non-blocking mode is also usually a good idea (but not |
707 | required if you know what you are doing). |
710 | required if you know what you are doing). |
708 | |
711 | |
709 | You have to be careful with dup'ed file descriptors, though. Some backends |
712 | You have to be careful with dup'ed file descriptors, though. Some backends |
710 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
713 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
711 | descriptors correctly if you register interest in two or more fds pointing |
714 | descriptors correctly if you register interest in two or more fds pointing |
712 | to the same underlying file/socket etc. description (that is, they share |
715 | to the same underlying file/socket/etc. description (that is, they share |
713 | the same underlying "file open"). |
716 | the same underlying "file open"). |
714 | |
717 | |
715 | If you must do this, then force the use of a known-to-be-good backend |
718 | If you must do this, then force the use of a known-to-be-good backend |
716 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
719 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
717 | C<EVBACKEND_POLL>). |
720 | C<EVBACKEND_POLL>). |
718 | |
721 | |
|
|
722 | Another thing you have to watch out for is that it is quite easy to |
|
|
723 | receive "spurious" readyness notifications, that is your callback might |
|
|
724 | be called with C<EV_READ> but a subsequent C<read>(2) will actually block |
|
|
725 | because there is no data. Not only are some backends known to create a |
|
|
726 | lot of those (for example solaris ports), it is very easy to get into |
|
|
727 | this situation even with a relatively standard program structure. Thus |
|
|
728 | it is best to always use non-blocking I/O: An extra C<read>(2) returning |
|
|
729 | C<EAGAIN> is far preferable to a program hanging until some data arrives. |
|
|
730 | |
|
|
731 | If you cannot run the fd in non-blocking mode (for example you should not |
|
|
732 | play around with an Xlib connection), then you have to seperately re-test |
|
|
733 | wether a file descriptor is really ready with a known-to-be good interface |
|
|
734 | such as poll (fortunately in our Xlib example, Xlib already does this on |
|
|
735 | its own, so its quite safe to use). |
|
|
736 | |
719 | =over 4 |
737 | =over 4 |
720 | |
738 | |
721 | =item ev_io_init (ev_io *, callback, int fd, int events) |
739 | =item ev_io_init (ev_io *, callback, int fd, int events) |
722 | |
740 | |
723 | =item ev_io_set (ev_io *, int fd, int events) |
741 | =item ev_io_set (ev_io *, int fd, int events) |
724 | |
742 | |
725 | Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive |
743 | Configures an C<ev_io> watcher. The C<fd> is the file descriptor to |
726 | events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ | |
744 | rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or |
727 | EV_WRITE> to receive the given events. |
745 | C<EV_READ | EV_WRITE> to receive the given events. |
728 | |
|
|
729 | Please note that most of the more scalable backend mechanisms (for example |
|
|
730 | epoll and solaris ports) can result in spurious readyness notifications |
|
|
731 | for file descriptors, so you practically need to use non-blocking I/O (and |
|
|
732 | treat callback invocation as hint only), or retest separately with a safe |
|
|
733 | interface before doing I/O (XLib can do this), or force the use of either |
|
|
734 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>, which don't suffer from this |
|
|
735 | problem. Also note that it is quite easy to have your callback invoked |
|
|
736 | when the readyness condition is no longer valid even when employing |
|
|
737 | typical ways of handling events, so its a good idea to use non-blocking |
|
|
738 | I/O unconditionally. |
|
|
739 | |
746 | |
740 | =back |
747 | =back |
741 | |
748 | |
742 | Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well |
749 | Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well |
743 | readable, but only once. Since it is likely line-buffered, you could |
750 | readable, but only once. Since it is likely line-buffered, you could |
… | |
… | |
756 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
763 | ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ); |
757 | ev_io_start (loop, &stdin_readable); |
764 | ev_io_start (loop, &stdin_readable); |
758 | ev_loop (loop, 0); |
765 | ev_loop (loop, 0); |
759 | |
766 | |
760 | |
767 | |
761 | =head2 C<ev_timer> - relative and optionally recurring timeouts |
768 | =head2 C<ev_timer> - relative and optionally repeating timeouts |
762 | |
769 | |
763 | Timer watchers are simple relative timers that generate an event after a |
770 | Timer watchers are simple relative timers that generate an event after a |
764 | given time, and optionally repeating in regular intervals after that. |
771 | given time, and optionally repeating in regular intervals after that. |
765 | |
772 | |
766 | The timers are based on real time, that is, if you register an event that |
773 | The timers are based on real time, that is, if you register an event that |
… | |
… | |
848 | // and in some piece of code that gets executed on any "activity": |
855 | // and in some piece of code that gets executed on any "activity": |
849 | // reset the timeout to start ticking again at 10 seconds |
856 | // reset the timeout to start ticking again at 10 seconds |
850 | ev_timer_again (&mytimer); |
857 | ev_timer_again (&mytimer); |
851 | |
858 | |
852 | |
859 | |
853 | =head2 C<ev_periodic> - to cron or not to cron |
860 | =head2 C<ev_periodic> - to cron or not to cron? |
854 | |
861 | |
855 | Periodic watchers are also timers of a kind, but they are very versatile |
862 | Periodic watchers are also timers of a kind, but they are very versatile |
856 | (and unfortunately a bit complex). |
863 | (and unfortunately a bit complex). |
857 | |
864 | |
858 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
865 | Unlike C<ev_timer>'s, they are not based on real time (or relative time) |
859 | but on wallclock time (absolute time). You can tell a periodic watcher |
866 | but on wallclock time (absolute time). You can tell a periodic watcher |
860 | to trigger "at" some specific point in time. For example, if you tell a |
867 | to trigger "at" some specific point in time. For example, if you tell a |
861 | periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now () |
868 | periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now () |
862 | + 10.>) and then reset your system clock to the last year, then it will |
869 | + 10.>) and then reset your system clock to the last year, then it will |
863 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
870 | take a year to trigger the event (unlike an C<ev_timer>, which would trigger |
864 | roughly 10 seconds later and of course not if you reset your system time |
871 | roughly 10 seconds later and of course not if you reset your system time |
865 | again). |
872 | again). |
866 | |
873 | |
… | |
… | |
986 | ev_periodic_init (&hourly_tick, clock_cb, |
993 | ev_periodic_init (&hourly_tick, clock_cb, |
987 | fmod (ev_now (loop), 3600.), 3600., 0); |
994 | fmod (ev_now (loop), 3600.), 3600., 0); |
988 | ev_periodic_start (loop, &hourly_tick); |
995 | ev_periodic_start (loop, &hourly_tick); |
989 | |
996 | |
990 | |
997 | |
991 | =head2 C<ev_signal> - signal me when a signal gets signalled |
998 | =head2 C<ev_signal> - signal me when a signal gets signalled! |
992 | |
999 | |
993 | Signal watchers will trigger an event when the process receives a specific |
1000 | Signal watchers will trigger an event when the process receives a specific |
994 | signal one or more times. Even though signals are very asynchronous, libev |
1001 | signal one or more times. Even though signals are very asynchronous, libev |
995 | will try it's best to deliver signals synchronously, i.e. as part of the |
1002 | will try it's best to deliver signals synchronously, i.e. as part of the |
996 | normal event processing, like any other event. |
1003 | normal event processing, like any other event. |
… | |
… | |
1012 | of the C<SIGxxx> constants). |
1019 | of the C<SIGxxx> constants). |
1013 | |
1020 | |
1014 | =back |
1021 | =back |
1015 | |
1022 | |
1016 | |
1023 | |
1017 | =head2 C<ev_child> - wait for pid status changes |
1024 | =head2 C<ev_child> - watch out for process status changes |
1018 | |
1025 | |
1019 | Child watchers trigger when your process receives a SIGCHLD in response to |
1026 | Child watchers trigger when your process receives a SIGCHLD in response to |
1020 | some child status changes (most typically when a child of yours dies). |
1027 | some child status changes (most typically when a child of yours dies). |
1021 | |
1028 | |
1022 | =over 4 |
1029 | =over 4 |
… | |
… | |
1045 | struct ev_signal signal_watcher; |
1052 | struct ev_signal signal_watcher; |
1046 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1053 | ev_signal_init (&signal_watcher, sigint_cb, SIGINT); |
1047 | ev_signal_start (loop, &sigint_cb); |
1054 | ev_signal_start (loop, &sigint_cb); |
1048 | |
1055 | |
1049 | |
1056 | |
1050 | =head2 C<ev_idle> - when you've got nothing better to do |
1057 | =head2 C<ev_idle> - when you've got nothing better to do... |
1051 | |
1058 | |
1052 | Idle watchers trigger events when there are no other events are pending |
1059 | Idle watchers trigger events when there are no other events are pending |
1053 | (prepare, check and other idle watchers do not count). That is, as long |
1060 | (prepare, check and other idle watchers do not count). That is, as long |
1054 | as your process is busy handling sockets or timeouts (or even signals, |
1061 | as your process is busy handling sockets or timeouts (or even signals, |
1055 | imagine) it will not be triggered. But when your process is idle all idle |
1062 | imagine) it will not be triggered. But when your process is idle all idle |
… | |
… | |
1089 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1096 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1090 | ev_idle_init (idle_watcher, idle_cb); |
1097 | ev_idle_init (idle_watcher, idle_cb); |
1091 | ev_idle_start (loop, idle_cb); |
1098 | ev_idle_start (loop, idle_cb); |
1092 | |
1099 | |
1093 | |
1100 | |
1094 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop |
1101 | =head2 C<ev_prepare> and C<ev_check> - customise your event loop! |
1095 | |
1102 | |
1096 | Prepare and check watchers are usually (but not always) used in tandem: |
1103 | Prepare and check watchers are usually (but not always) used in tandem: |
1097 | prepare watchers get invoked before the process blocks and check watchers |
1104 | prepare watchers get invoked before the process blocks and check watchers |
1098 | afterwards. |
1105 | afterwards. |
1099 | |
1106 | |
… | |
… | |
1133 | =back |
1140 | =back |
1134 | |
1141 | |
1135 | Example: *TODO*. |
1142 | Example: *TODO*. |
1136 | |
1143 | |
1137 | |
1144 | |
1138 | =head2 C<ev_embed> - when one backend isn't enough |
1145 | =head2 C<ev_embed> - when one backend isn't enough... |
1139 | |
1146 | |
1140 | This is a rather advanced watcher type that lets you embed one event loop |
1147 | This is a rather advanced watcher type that lets you embed one event loop |
1141 | into another (currently only C<ev_io> events are supported in the embedded |
1148 | into another (currently only C<ev_io> events are supported in the embedded |
1142 | loop, other types of watchers might be handled in a delayed or incorrect |
1149 | loop, other types of watchers might be handled in a delayed or incorrect |
1143 | fashion and must not be used). |
1150 | fashion and must not be used). |
… | |
… | |
1310 | |
1317 | |
1311 | =back |
1318 | =back |
1312 | |
1319 | |
1313 | =head1 C++ SUPPORT |
1320 | =head1 C++ SUPPORT |
1314 | |
1321 | |
1315 | TBD. |
1322 | Libev comes with some simplistic wrapper classes for C++ that mainly allow |
|
|
1323 | you to use some convinience methods to start/stop watchers and also change |
|
|
1324 | the callback model to a model using method callbacks on objects. |
|
|
1325 | |
|
|
1326 | To use it, |
|
|
1327 | |
|
|
1328 | #include <ev++.h> |
|
|
1329 | |
|
|
1330 | (it is not installed by default). This automatically includes F<ev.h> |
|
|
1331 | and puts all of its definitions (many of them macros) into the global |
|
|
1332 | namespace. All C++ specific things are put into the C<ev> namespace. |
|
|
1333 | |
|
|
1334 | It should support all the same embedding options as F<ev.h>, most notably |
|
|
1335 | C<EV_MULTIPLICITY>. |
|
|
1336 | |
|
|
1337 | Here is a list of things available in the C<ev> namespace: |
|
|
1338 | |
|
|
1339 | =over 4 |
|
|
1340 | |
|
|
1341 | =item C<ev::READ>, C<ev::WRITE> etc. |
|
|
1342 | |
|
|
1343 | These are just enum values with the same values as the C<EV_READ> etc. |
|
|
1344 | macros from F<ev.h>. |
|
|
1345 | |
|
|
1346 | =item C<ev::tstamp>, C<ev::now> |
|
|
1347 | |
|
|
1348 | Aliases to the same types/functions as with the C<ev_> prefix. |
|
|
1349 | |
|
|
1350 | =item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc. |
|
|
1351 | |
|
|
1352 | For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of |
|
|
1353 | the same name in the C<ev> namespace, with the exception of C<ev_signal> |
|
|
1354 | which is called C<ev::sig> to avoid clashes with the C<signal> macro |
|
|
1355 | defines by many implementations. |
|
|
1356 | |
|
|
1357 | All of those classes have these methods: |
|
|
1358 | |
|
|
1359 | =over 4 |
|
|
1360 | |
|
|
1361 | =item ev::TYPE::TYPE (object *, object::method *) |
|
|
1362 | |
|
|
1363 | =item ev::TYPE::TYPE (object *, object::method *, struct ev_loop *) |
|
|
1364 | |
|
|
1365 | =item ev::TYPE::~TYPE |
|
|
1366 | |
|
|
1367 | The constructor takes a pointer to an object and a method pointer to |
|
|
1368 | the event handler callback to call in this class. The constructor calls |
|
|
1369 | C<ev_init> for you, which means you have to call the C<set> method |
|
|
1370 | before starting it. If you do not specify a loop then the constructor |
|
|
1371 | automatically associates the default loop with this watcher. |
|
|
1372 | |
|
|
1373 | The destructor automatically stops the watcher if it is active. |
|
|
1374 | |
|
|
1375 | =item w->set (struct ev_loop *) |
|
|
1376 | |
|
|
1377 | Associates a different C<struct ev_loop> with this watcher. You can only |
|
|
1378 | do this when the watcher is inactive (and not pending either). |
|
|
1379 | |
|
|
1380 | =item w->set ([args]) |
|
|
1381 | |
|
|
1382 | Basically the same as C<ev_TYPE_set>, with the same args. Must be |
|
|
1383 | called at least once. Unlike the C counterpart, an active watcher gets |
|
|
1384 | automatically stopped and restarted. |
|
|
1385 | |
|
|
1386 | =item w->start () |
|
|
1387 | |
|
|
1388 | Starts the watcher. Note that there is no C<loop> argument as the |
|
|
1389 | constructor already takes the loop. |
|
|
1390 | |
|
|
1391 | =item w->stop () |
|
|
1392 | |
|
|
1393 | Stops the watcher if it is active. Again, no C<loop> argument. |
|
|
1394 | |
|
|
1395 | =item w->again () C<ev::timer>, C<ev::periodic> only |
|
|
1396 | |
|
|
1397 | For C<ev::timer> and C<ev::periodic>, this invokes the corresponding |
|
|
1398 | C<ev_TYPE_again> function. |
|
|
1399 | |
|
|
1400 | =item w->sweep () C<ev::embed> only |
|
|
1401 | |
|
|
1402 | Invokes C<ev_embed_sweep>. |
|
|
1403 | |
|
|
1404 | =back |
|
|
1405 | |
|
|
1406 | =back |
|
|
1407 | |
|
|
1408 | Example: Define a class with an IO and idle watcher, start one of them in |
|
|
1409 | the constructor. |
|
|
1410 | |
|
|
1411 | class myclass |
|
|
1412 | { |
|
|
1413 | ev_io io; void io_cb (ev::io &w, int revents); |
|
|
1414 | ev_idle idle void idle_cb (ev::idle &w, int revents); |
|
|
1415 | |
|
|
1416 | myclass (); |
|
|
1417 | } |
|
|
1418 | |
|
|
1419 | myclass::myclass (int fd) |
|
|
1420 | : io (this, &myclass::io_cb), |
|
|
1421 | idle (this, &myclass::idle_cb) |
|
|
1422 | { |
|
|
1423 | io.start (fd, ev::READ); |
|
|
1424 | } |
|
|
1425 | |
|
|
1426 | =head1 EMBEDDING |
|
|
1427 | |
|
|
1428 | Libev can (and often is) directly embedded into host |
|
|
1429 | applications. Examples of applications that embed it include the Deliantra |
|
|
1430 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
|
|
1431 | and rxvt-unicode. |
|
|
1432 | |
|
|
1433 | The goal is to enable you to just copy the neecssary files into your |
|
|
1434 | source directory without having to change even a single line in them, so |
|
|
1435 | you can easily upgrade by simply copying (or having a checked-out copy of |
|
|
1436 | libev somewhere in your source tree). |
|
|
1437 | |
|
|
1438 | =head2 FILESETS |
|
|
1439 | |
|
|
1440 | Depending on what features you need you need to include one or more sets of files |
|
|
1441 | in your app. |
|
|
1442 | |
|
|
1443 | =head3 CORE EVENT LOOP |
|
|
1444 | |
|
|
1445 | To include only the libev core (all the C<ev_*> functions), with manual |
|
|
1446 | configuration (no autoconf): |
|
|
1447 | |
|
|
1448 | #define EV_STANDALONE 1 |
|
|
1449 | #include "ev.c" |
|
|
1450 | |
|
|
1451 | This will automatically include F<ev.h>, too, and should be done in a |
|
|
1452 | single C source file only to provide the function implementations. To use |
|
|
1453 | it, do the same for F<ev.h> in all files wishing to use this API (best |
|
|
1454 | done by writing a wrapper around F<ev.h> that you can include instead and |
|
|
1455 | where you can put other configuration options): |
|
|
1456 | |
|
|
1457 | #define EV_STANDALONE 1 |
|
|
1458 | #include "ev.h" |
|
|
1459 | |
|
|
1460 | Both header files and implementation files can be compiled with a C++ |
|
|
1461 | compiler (at least, thats a stated goal, and breakage will be treated |
|
|
1462 | as a bug). |
|
|
1463 | |
|
|
1464 | You need the following files in your source tree, or in a directory |
|
|
1465 | in your include path (e.g. in libev/ when using -Ilibev): |
|
|
1466 | |
|
|
1467 | ev.h |
|
|
1468 | ev.c |
|
|
1469 | ev_vars.h |
|
|
1470 | ev_wrap.h |
|
|
1471 | |
|
|
1472 | ev_win32.c required on win32 platforms only |
|
|
1473 | |
|
|
1474 | ev_select.c only when select backend is enabled (which is by default) |
|
|
1475 | ev_poll.c only when poll backend is enabled (disabled by default) |
|
|
1476 | ev_epoll.c only when the epoll backend is enabled (disabled by default) |
|
|
1477 | ev_kqueue.c only when the kqueue backend is enabled (disabled by default) |
|
|
1478 | ev_port.c only when the solaris port backend is enabled (disabled by default) |
|
|
1479 | |
|
|
1480 | F<ev.c> includes the backend files directly when enabled, so you only need |
|
|
1481 | to compile this single file. |
|
|
1482 | |
|
|
1483 | =head3 LIBEVENT COMPATIBILITY API |
|
|
1484 | |
|
|
1485 | To include the libevent compatibility API, also include: |
|
|
1486 | |
|
|
1487 | #include "event.c" |
|
|
1488 | |
|
|
1489 | in the file including F<ev.c>, and: |
|
|
1490 | |
|
|
1491 | #include "event.h" |
|
|
1492 | |
|
|
1493 | in the files that want to use the libevent API. This also includes F<ev.h>. |
|
|
1494 | |
|
|
1495 | You need the following additional files for this: |
|
|
1496 | |
|
|
1497 | event.h |
|
|
1498 | event.c |
|
|
1499 | |
|
|
1500 | =head3 AUTOCONF SUPPORT |
|
|
1501 | |
|
|
1502 | Instead of using C<EV_STANDALONE=1> and providing your config in |
|
|
1503 | whatever way you want, you can also C<m4_include([libev.m4])> in your |
|
|
1504 | F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then |
|
|
1505 | include F<config.h> and configure itself accordingly. |
|
|
1506 | |
|
|
1507 | For this of course you need the m4 file: |
|
|
1508 | |
|
|
1509 | libev.m4 |
|
|
1510 | |
|
|
1511 | =head2 PREPROCESSOR SYMBOLS/MACROS |
|
|
1512 | |
|
|
1513 | Libev can be configured via a variety of preprocessor symbols you have to define |
|
|
1514 | before including any of its files. The default is not to build for multiplicity |
|
|
1515 | and only include the select backend. |
|
|
1516 | |
|
|
1517 | =over 4 |
|
|
1518 | |
|
|
1519 | =item EV_STANDALONE |
|
|
1520 | |
|
|
1521 | Must always be C<1> if you do not use autoconf configuration, which |
|
|
1522 | keeps libev from including F<config.h>, and it also defines dummy |
|
|
1523 | implementations for some libevent functions (such as logging, which is not |
|
|
1524 | supported). It will also not define any of the structs usually found in |
|
|
1525 | F<event.h> that are not directly supported by the libev core alone. |
|
|
1526 | |
|
|
1527 | =item EV_USE_MONOTONIC |
|
|
1528 | |
|
|
1529 | If defined to be C<1>, libev will try to detect the availability of the |
|
|
1530 | monotonic clock option at both compiletime and runtime. Otherwise no use |
|
|
1531 | of the monotonic clock option will be attempted. If you enable this, you |
|
|
1532 | usually have to link against librt or something similar. Enabling it when |
|
|
1533 | the functionality isn't available is safe, though, althoguh you have |
|
|
1534 | to make sure you link against any libraries where the C<clock_gettime> |
|
|
1535 | function is hiding in (often F<-lrt>). |
|
|
1536 | |
|
|
1537 | =item EV_USE_REALTIME |
|
|
1538 | |
|
|
1539 | If defined to be C<1>, libev will try to detect the availability of the |
|
|
1540 | realtime clock option at compiletime (and assume its availability at |
|
|
1541 | runtime if successful). Otherwise no use of the realtime clock option will |
|
|
1542 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
|
|
1543 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries |
|
|
1544 | in the description of C<EV_USE_MONOTONIC>, though. |
|
|
1545 | |
|
|
1546 | =item EV_USE_SELECT |
|
|
1547 | |
|
|
1548 | If undefined or defined to be C<1>, libev will compile in support for the |
|
|
1549 | C<select>(2) backend. No attempt at autodetection will be done: if no |
|
|
1550 | other method takes over, select will be it. Otherwise the select backend |
|
|
1551 | will not be compiled in. |
|
|
1552 | |
|
|
1553 | =item EV_SELECT_USE_FD_SET |
|
|
1554 | |
|
|
1555 | If defined to C<1>, then the select backend will use the system C<fd_set> |
|
|
1556 | structure. This is useful if libev doesn't compile due to a missing |
|
|
1557 | C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on |
|
|
1558 | exotic systems. This usually limits the range of file descriptors to some |
|
|
1559 | low limit such as 1024 or might have other limitations (winsocket only |
|
|
1560 | allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might |
|
|
1561 | influence the size of the C<fd_set> used. |
|
|
1562 | |
|
|
1563 | =item EV_SELECT_IS_WINSOCKET |
|
|
1564 | |
|
|
1565 | When defined to C<1>, the select backend will assume that |
|
|
1566 | select/socket/connect etc. don't understand file descriptors but |
|
|
1567 | wants osf handles on win32 (this is the case when the select to |
|
|
1568 | be used is the winsock select). This means that it will call |
|
|
1569 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
|
|
1570 | it is assumed that all these functions actually work on fds, even |
|
|
1571 | on win32. Should not be defined on non-win32 platforms. |
|
|
1572 | |
|
|
1573 | =item EV_USE_POLL |
|
|
1574 | |
|
|
1575 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
|
|
1576 | backend. Otherwise it will be enabled on non-win32 platforms. It |
|
|
1577 | takes precedence over select. |
|
|
1578 | |
|
|
1579 | =item EV_USE_EPOLL |
|
|
1580 | |
|
|
1581 | If defined to be C<1>, libev will compile in support for the Linux |
|
|
1582 | C<epoll>(7) backend. Its availability will be detected at runtime, |
|
|
1583 | otherwise another method will be used as fallback. This is the |
|
|
1584 | preferred backend for GNU/Linux systems. |
|
|
1585 | |
|
|
1586 | =item EV_USE_KQUEUE |
|
|
1587 | |
|
|
1588 | If defined to be C<1>, libev will compile in support for the BSD style |
|
|
1589 | C<kqueue>(2) backend. Its actual availability will be detected at runtime, |
|
|
1590 | otherwise another method will be used as fallback. This is the preferred |
|
|
1591 | backend for BSD and BSD-like systems, although on most BSDs kqueue only |
|
|
1592 | supports some types of fds correctly (the only platform we found that |
|
|
1593 | supports ptys for example was NetBSD), so kqueue might be compiled in, but |
|
|
1594 | not be used unless explicitly requested. The best way to use it is to find |
|
|
1595 | out whether kqueue supports your type of fd properly and use an embedded |
|
|
1596 | kqueue loop. |
|
|
1597 | |
|
|
1598 | =item EV_USE_PORT |
|
|
1599 | |
|
|
1600 | If defined to be C<1>, libev will compile in support for the Solaris |
|
|
1601 | 10 port style backend. Its availability will be detected at runtime, |
|
|
1602 | otherwise another method will be used as fallback. This is the preferred |
|
|
1603 | backend for Solaris 10 systems. |
|
|
1604 | |
|
|
1605 | =item EV_USE_DEVPOLL |
|
|
1606 | |
|
|
1607 | reserved for future expansion, works like the USE symbols above. |
|
|
1608 | |
|
|
1609 | =item EV_H |
|
|
1610 | |
|
|
1611 | The name of the F<ev.h> header file used to include it. The default if |
|
|
1612 | undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This |
|
|
1613 | can be used to virtually rename the F<ev.h> header file in case of conflicts. |
|
|
1614 | |
|
|
1615 | =item EV_CONFIG_H |
|
|
1616 | |
|
|
1617 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
|
|
1618 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
|
|
1619 | C<EV_H>, above. |
|
|
1620 | |
|
|
1621 | =item EV_EVENT_H |
|
|
1622 | |
|
|
1623 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
|
|
1624 | of how the F<event.h> header can be found. |
|
|
1625 | |
|
|
1626 | =item EV_PROTOTYPES |
|
|
1627 | |
|
|
1628 | If defined to be C<0>, then F<ev.h> will not define any function |
|
|
1629 | prototypes, but still define all the structs and other symbols. This is |
|
|
1630 | occasionally useful if you want to provide your own wrapper functions |
|
|
1631 | around libev functions. |
|
|
1632 | |
|
|
1633 | =item EV_MULTIPLICITY |
|
|
1634 | |
|
|
1635 | If undefined or defined to C<1>, then all event-loop-specific functions |
|
|
1636 | will have the C<struct ev_loop *> as first argument, and you can create |
|
|
1637 | additional independent event loops. Otherwise there will be no support |
|
|
1638 | for multiple event loops and there is no first event loop pointer |
|
|
1639 | argument. Instead, all functions act on the single default loop. |
|
|
1640 | |
|
|
1641 | =item EV_PERIODICS |
|
|
1642 | |
|
|
1643 | If undefined or defined to be C<1>, then periodic timers are supported, |
|
|
1644 | otherwise not. This saves a few kb of code. |
|
|
1645 | |
|
|
1646 | =item EV_COMMON |
|
|
1647 | |
|
|
1648 | By default, all watchers have a C<void *data> member. By redefining |
|
|
1649 | this macro to a something else you can include more and other types of |
|
|
1650 | members. You have to define it each time you include one of the files, |
|
|
1651 | though, and it must be identical each time. |
|
|
1652 | |
|
|
1653 | For example, the perl EV module uses something like this: |
|
|
1654 | |
|
|
1655 | #define EV_COMMON \ |
|
|
1656 | SV *self; /* contains this struct */ \ |
|
|
1657 | SV *cb_sv, *fh /* note no trailing ";" */ |
|
|
1658 | |
|
|
1659 | =item EV_CB_DECLARE(type) |
|
|
1660 | |
|
|
1661 | =item EV_CB_INVOKE(watcher,revents) |
|
|
1662 | |
|
|
1663 | =item ev_set_cb(ev,cb) |
|
|
1664 | |
|
|
1665 | Can be used to change the callback member declaration in each watcher, |
|
|
1666 | and the way callbacks are invoked and set. Must expand to a struct member |
|
|
1667 | definition and a statement, respectively. See the F<ev.v> header file for |
|
|
1668 | their default definitions. One possible use for overriding these is to |
|
|
1669 | avoid the ev_loop pointer as first argument in all cases, or to use method |
|
|
1670 | calls instead of plain function calls in C++. |
|
|
1671 | |
|
|
1672 | =head2 EXAMPLES |
|
|
1673 | |
|
|
1674 | For a real-world example of a program the includes libev |
|
|
1675 | verbatim, you can have a look at the EV perl module |
|
|
1676 | (L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in |
|
|
1677 | the F<libev/> subdirectory and includes them in the F<EV/EVAPI.h> (public |
|
|
1678 | interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file |
|
|
1679 | will be compiled. It is pretty complex because it provides its own header |
|
|
1680 | file. |
|
|
1681 | |
|
|
1682 | The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file |
|
|
1683 | that everybody includes and which overrides some autoconf choices: |
|
|
1684 | |
|
|
1685 | #define EV_USE_POLL 0 |
|
|
1686 | #define EV_MULTIPLICITY 0 |
|
|
1687 | #define EV_PERIODICS 0 |
|
|
1688 | #define EV_CONFIG_H <config.h> |
|
|
1689 | |
|
|
1690 | #include "ev++.h" |
|
|
1691 | |
|
|
1692 | And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: |
|
|
1693 | |
|
|
1694 | #include "ev_cpp.h" |
|
|
1695 | #include "ev.c" |
1316 | |
1696 | |
1317 | =head1 AUTHOR |
1697 | =head1 AUTHOR |
1318 | |
1698 | |
1319 | Marc Lehmann <libev@schmorp.de>. |
1699 | Marc Lehmann <libev@schmorp.de>. |
1320 | |
1700 | |