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

Comparing libev/ev.pod (file contents):
Revision 1.206 by root, Tue Oct 28 12:31:38 2008 UTC vs.
Revision 1.207 by root, Tue Oct 28 14:13:52 2008 UTC

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
1926This watches a file system path for attribute changes. That is, it calls 1926This watches a file system path for attribute changes. That is, it calls
1927C<stat> regularly (or when the OS says it changed) and sees if it changed 1927C<stat> on that path in regular intervals (or when the OS says it changed)
1928compared to the last time, invoking the callback if it did. 1928and sees if it changed compared to the last time, invoking the callback if
1929it did.
1929 1930
1930The path does not need to exist: changing from "path exists" to "path does 1931The path does not need to exist: changing from "path exists" to "path does
1931not exist" is a status change like any other. The condition "path does 1932not exist" is a status change like any other. The condition "path does
1932not exist" is signified by the C<st_nlink> field being zero (which is 1933not exist" is signified by the C<st_nlink> field being zero (which is
1933otherwise always forced to be at least one) and all the other fields of 1934otherwise always forced to be at least one) and all the other fields of
1934the stat buffer having unspecified contents. 1935the stat buffer having unspecified contents.
1935 1936
1936The path I<should> be absolute and I<must not> end in a slash. If it is 1937The path I<must not> end in a slash or contain special components such as
1938C<.> or C<..>. The path I<should> be absolute: If it is relative and
1937relative and your working directory changes, the behaviour is undefined. 1939your working directory changes, then the behaviour is undefined.
1938 1940
1939Since there is no standard kernel interface to do this, the portable 1941Since there is no portable change notification interface available, the
1940implementation simply calls C<stat (2)> regularly on the path to see if 1942portable implementation simply calls C<stat(2)> regularly on the path
1941it changed somehow. You can specify a recommended polling interval for 1943to see if it changed somehow. You can specify a recommended polling
1942this case. If you specify a polling interval of C<0> (highly recommended!) 1944interval for this case. If you specify a polling interval of C<0> (highly
1943then a I<suitable, unspecified default> value will be used (which 1945recommended!) then a I<suitable, unspecified default> value will be used
1944you can expect to be around five seconds, although this might change 1946(which you can expect to be around five seconds, although this might
1945dynamically). Libev will also impose a minimum interval which is currently 1947change dynamically). Libev will also impose a minimum interval which is
1946around C<0.1>, but thats usually overkill. 1948currently around C<0.1>, but thats usually overkill.
1947 1949
1948This watcher type is not meant for massive numbers of stat watchers, 1950This watcher type is not meant for massive numbers of stat watchers,
1949as even with OS-supported change notifications, this can be 1951as even with OS-supported change notifications, this can be
1950resource-intensive. 1952resource-intensive.
1951 1953
1961support disabled by default, you get the 32 bit version of the stat 1963support disabled by default, you get the 32 bit version of the stat
1962structure. When using the library from programs that change the ABI to 1964structure. When using the library from programs that change the ABI to
1963use 64 bit file offsets the programs will fail. In that case you have to 1965use 64 bit file offsets the programs will fail. In that case you have to
1964compile libev with the same flags to get binary compatibility. This is 1966compile libev with the same flags to get binary compatibility. This is
1965obviously the case with any flags that change the ABI, but the problem is 1967obviously the case with any flags that change the ABI, but the problem is
1966most noticeably disabled with ev_stat and large file support. 1968most noticeably displayed with ev_stat and large file support.
1967 1969
1968The solution for this is to lobby your distribution maker to make large 1970The solution for this is to lobby your distribution maker to make large
1969file interfaces available by default (as e.g. FreeBSD does) and not 1971file interfaces available by default (as e.g. FreeBSD does) and not
1970optional. Libev cannot simply switch on large file support because it has 1972optional. Libev cannot simply switch on large file support because it has
1971to exchange stat structures with application programs compiled using the 1973to exchange stat structures with application programs compiled using the
1990descriptor open on the object at all times, and detecting renames, unlinks 1992descriptor open on the object at all times, and detecting renames, unlinks
1991etc. is difficult. 1993etc. is difficult.
1992 1994
1993=head3 The special problem of stat time resolution 1995=head3 The special problem of stat time resolution
1994 1996
1995The C<stat ()> system call only supports full-second resolution portably, and 1997The C<stat ()> system call only supports full-second resolution portably,
1996even on systems where the resolution is higher, most file systems still 1998and even on systems where the resolution is higher, most file systems
1997only support whole seconds. 1999still only support whole seconds.
1998 2000
1999That means that, if the time is the only thing that changes, you can 2001That means that, if the time is the only thing that changes, you can
2000easily miss updates: on the first update, C<ev_stat> detects a change and 2002easily miss updates: on the first update, C<ev_stat> detects a change and
2001calls your callback, which does something. When there is another update 2003calls your callback, which does something. When there is another update
2002within the same second, C<ev_stat> will be unable to detect unless the 2004within the same second, C<ev_stat> will be unable to detect unless the

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines