… | |
… | |
298 | If you don't know what event loop to use, use the one returned from this |
298 | If you don't know what event loop to use, use the one returned from this |
299 | function. |
299 | function. |
300 | |
300 | |
301 | Note that this function is I<not> thread-safe, so if you want to use it |
301 | Note that this function is I<not> thread-safe, so if you want to use it |
302 | from multiple threads, you have to lock (note also that this is unlikely, |
302 | from multiple threads, you have to lock (note also that this is unlikely, |
303 | as loops cannot bes hared easily between threads anyway). |
303 | as loops cannot be shared easily between threads anyway). |
304 | |
304 | |
305 | The default loop is the only loop that can handle C<ev_signal> and |
305 | The default loop is the only loop that can handle C<ev_signal> and |
306 | C<ev_child> watchers, and to do this, it always registers a handler |
306 | C<ev_child> watchers, and to do this, it always registers a handler |
307 | for C<SIGCHLD>. If this is a problem for your application you can either |
307 | for C<SIGCHLD>. If this is a problem for your application you can either |
308 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
308 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
… | |
… | |
647 | the loop. |
647 | the loop. |
648 | |
648 | |
649 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
649 | A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if |
650 | necessary) and will handle those and any already outstanding ones. It |
650 | necessary) and will handle those and any already outstanding ones. It |
651 | will block your process until at least one new event arrives (which could |
651 | will block your process until at least one new event arrives (which could |
652 | be an event internal to libev itself, so there is no guarentee that a |
652 | be an event internal to libev itself, so there is no guarantee that a |
653 | user-registered callback will be called), and will return after one |
653 | user-registered callback will be called), and will return after one |
654 | iteration of the loop. |
654 | iteration of the loop. |
655 | |
655 | |
656 | This is useful if you are waiting for some external event in conjunction |
656 | This is useful if you are waiting for some external event in conjunction |
657 | with something not expressible using other libev watchers (i.e. "roll your |
657 | with something not expressible using other libev watchers (i.e. "roll your |
… | |
… | |
1922 | |
1922 | |
1923 | |
1923 | |
1924 | =head2 C<ev_stat> - did the file attributes just change? |
1924 | =head2 C<ev_stat> - did the file attributes just change? |
1925 | |
1925 | |
1926 | This watches a file system path for attribute changes. That is, it calls |
1926 | This watches a file system path for attribute changes. That is, it calls |
1927 | C<stat> regularly (or when the OS says it changed) and sees if it changed |
1927 | C<stat> on that path in regular intervals (or when the OS says it changed) |
1928 | compared to the last time, invoking the callback if it did. |
1928 | and sees if it changed compared to the last time, invoking the callback if |
|
|
1929 | it did. |
1929 | |
1930 | |
1930 | The path does not need to exist: changing from "path exists" to "path does |
1931 | The path does not need to exist: changing from "path exists" to "path does |
1931 | not exist" is a status change like any other. The condition "path does |
1932 | not exist" is a status change like any other. The condition "path does |
1932 | not exist" is signified by the C<st_nlink> field being zero (which is |
1933 | not exist" is signified by the C<st_nlink> field being zero (which is |
1933 | otherwise always forced to be at least one) and all the other fields of |
1934 | otherwise always forced to be at least one) and all the other fields of |
1934 | the stat buffer having unspecified contents. |
1935 | the stat buffer having unspecified contents. |
1935 | |
1936 | |
1936 | The path I<should> be absolute and I<must not> end in a slash. If it is |
1937 | The path I<must not> end in a slash or contain special components such as |
|
|
1938 | C<.> or C<..>. The path I<should> be absolute: If it is relative and |
1937 | relative and your working directory changes, the behaviour is undefined. |
1939 | your working directory changes, then the behaviour is undefined. |
1938 | |
1940 | |
1939 | Since there is no standard kernel interface to do this, the portable |
1941 | Since there is no portable change notification interface available, the |
1940 | implementation simply calls C<stat (2)> regularly on the path to see if |
1942 | portable implementation simply calls C<stat(2)> regularly on the path |
1941 | it changed somehow. You can specify a recommended polling interval for |
1943 | to see if it changed somehow. You can specify a recommended polling |
1942 | this case. If you specify a polling interval of C<0> (highly recommended!) |
1944 | interval for this case. If you specify a polling interval of C<0> (highly |
1943 | then a I<suitable, unspecified default> value will be used (which |
1945 | recommended!) then a I<suitable, unspecified default> value will be used |
1944 | you can expect to be around five seconds, although this might change |
1946 | (which you can expect to be around five seconds, although this might |
1945 | dynamically). Libev will also impose a minimum interval which is currently |
1947 | change dynamically). Libev will also impose a minimum interval which is |
1946 | around C<0.1>, but thats usually overkill. |
1948 | currently around C<0.1>, but that's usually overkill. |
1947 | |
1949 | |
1948 | This watcher type is not meant for massive numbers of stat watchers, |
1950 | This watcher type is not meant for massive numbers of stat watchers, |
1949 | as even with OS-supported change notifications, this can be |
1951 | as even with OS-supported change notifications, this can be |
1950 | resource-intensive. |
1952 | resource-intensive. |
1951 | |
1953 | |
… | |
… | |
1961 | support disabled by default, you get the 32 bit version of the stat |
1963 | support disabled by default, you get the 32 bit version of the stat |
1962 | structure. When using the library from programs that change the ABI to |
1964 | structure. When using the library from programs that change the ABI to |
1963 | use 64 bit file offsets the programs will fail. In that case you have to |
1965 | use 64 bit file offsets the programs will fail. In that case you have to |
1964 | compile libev with the same flags to get binary compatibility. This is |
1966 | compile libev with the same flags to get binary compatibility. This is |
1965 | obviously the case with any flags that change the ABI, but the problem is |
1967 | obviously the case with any flags that change the ABI, but the problem is |
1966 | most noticeably disabled with ev_stat and large file support. |
1968 | most noticeably displayed with ev_stat and large file support. |
1967 | |
1969 | |
1968 | The solution for this is to lobby your distribution maker to make large |
1970 | The solution for this is to lobby your distribution maker to make large |
1969 | file interfaces available by default (as e.g. FreeBSD does) and not |
1971 | file interfaces available by default (as e.g. FreeBSD does) and not |
1970 | optional. Libev cannot simply switch on large file support because it has |
1972 | optional. Libev cannot simply switch on large file support because it has |
1971 | to exchange stat structures with application programs compiled using the |
1973 | to exchange stat structures with application programs compiled using the |
… | |
… | |
1990 | descriptor open on the object at all times, and detecting renames, unlinks |
1992 | descriptor open on the object at all times, and detecting renames, unlinks |
1991 | etc. is difficult. |
1993 | etc. is difficult. |
1992 | |
1994 | |
1993 | =head3 The special problem of stat time resolution |
1995 | =head3 The special problem of stat time resolution |
1994 | |
1996 | |
1995 | The C<stat ()> system call only supports full-second resolution portably, and |
1997 | The C<stat ()> system call only supports full-second resolution portably, |
1996 | even on systems where the resolution is higher, most file systems still |
1998 | and even on systems where the resolution is higher, most file systems |
1997 | only support whole seconds. |
1999 | still only support whole seconds. |
1998 | |
2000 | |
1999 | That means that, if the time is the only thing that changes, you can |
2001 | That means that, if the time is the only thing that changes, you can |
2000 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2002 | easily miss updates: on the first update, C<ev_stat> detects a change and |
2001 | calls your callback, which does something. When there is another update |
2003 | calls your callback, which does something. When there is another update |
2002 | within the same second, C<ev_stat> will be unable to detect unless the |
2004 | within the same second, C<ev_stat> will be unable to detect unless the |
… | |
… | |
2641 | =over 4 |
2643 | =over 4 |
2642 | |
2644 | |
2643 | =item ev_async_init (ev_async *, callback) |
2645 | =item ev_async_init (ev_async *, callback) |
2644 | |
2646 | |
2645 | Initialises and configures the async watcher - it has no parameters of any |
2647 | Initialises and configures the async watcher - it has no parameters of any |
2646 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
2648 | kind. There is a C<ev_async_set> macro, but using it is utterly pointless, |
2647 | trust me. |
2649 | trust me. |
2648 | |
2650 | |
2649 | =item ev_async_send (loop, ev_async *) |
2651 | =item ev_async_send (loop, ev_async *) |
2650 | |
2652 | |
2651 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
2653 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
… | |
… | |
3084 | |
3086 | |
3085 | #define EV_STANDALONE 1 |
3087 | #define EV_STANDALONE 1 |
3086 | #include "ev.h" |
3088 | #include "ev.h" |
3087 | |
3089 | |
3088 | Both header files and implementation files can be compiled with a C++ |
3090 | Both header files and implementation files can be compiled with a C++ |
3089 | compiler (at least, thats a stated goal, and breakage will be treated |
3091 | compiler (at least, that's a stated goal, and breakage will be treated |
3090 | as a bug). |
3092 | as a bug). |
3091 | |
3093 | |
3092 | You need the following files in your source tree, or in a directory |
3094 | You need the following files in your source tree, or in a directory |
3093 | in your include path (e.g. in libev/ when using -Ilibev): |
3095 | in your include path (e.g. in libev/ when using -Ilibev): |
3094 | |
3096 | |
… | |
… | |
3566 | loop, as long as you don't confuse yourself). The only exception is that |
3568 | loop, as long as you don't confuse yourself). The only exception is that |
3567 | you must not do this from C<ev_periodic> reschedule callbacks. |
3569 | you must not do this from C<ev_periodic> reschedule callbacks. |
3568 | |
3570 | |
3569 | Care has been taken to ensure that libev does not keep local state inside |
3571 | Care has been taken to ensure that libev does not keep local state inside |
3570 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3572 | C<ev_loop>, and other calls do not usually allow for coroutine switches as |
3571 | they do not clal any callbacks. |
3573 | they do not call any callbacks. |
3572 | |
3574 | |
3573 | =head2 COMPILER WARNINGS |
3575 | =head2 COMPILER WARNINGS |
3574 | |
3576 | |
3575 | Depending on your compiler and compiler settings, you might get no or a |
3577 | Depending on your compiler and compiler settings, you might get no or a |
3576 | lot of warnings when compiling libev code. Some people are apparently |
3578 | lot of warnings when compiling libev code. Some people are apparently |
… | |
… | |
3610 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3612 | ==2274== definitely lost: 0 bytes in 0 blocks. |
3611 | ==2274== possibly lost: 0 bytes in 0 blocks. |
3613 | ==2274== possibly lost: 0 bytes in 0 blocks. |
3612 | ==2274== still reachable: 256 bytes in 1 blocks. |
3614 | ==2274== still reachable: 256 bytes in 1 blocks. |
3613 | |
3615 | |
3614 | Then there is no memory leak, just as memory accounted to global variables |
3616 | Then there is no memory leak, just as memory accounted to global variables |
3615 | is not a memleak - the memory is still being refernced, and didn't leak. |
3617 | is not a memleak - the memory is still being referenced, and didn't leak. |
3616 | |
3618 | |
3617 | Similarly, under some circumstances, valgrind might report kernel bugs |
3619 | Similarly, under some circumstances, valgrind might report kernel bugs |
3618 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
3620 | as if it were a bug in libev (e.g. in realloc or in the poll backend, |
3619 | although an acceptable workaround has been found here), or it might be |
3621 | although an acceptable workaround has been found here), or it might be |
3620 | confused. |
3622 | confused. |