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

Comparing libev/ev.pod (file contents):
Revision 1.83 by root, Wed Dec 12 17:55:31 2007 UTC vs.
Revision 1.86 by root, Tue Dec 18 01:20:33 2007 UTC

… …
98Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
100the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
101called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
102to the C<double> type in C, and when you need to do any calculations on 102to the C<double> type in C, and when you need to do any calculations on
103it, you should treat it as such. 103it, you should treat it as some floatingpoint value. Unlike the name
104component C<stamp> might indicate, it is also used for time differences
105throughout libev.
104 106
105=head1 GLOBAL FUNCTIONS 107=head1 GLOBAL FUNCTIONS
106 108
107These functions can be called anytime, even before initialising the 109These functions can be called anytime, even before initialising the
108library in any way. 110library in any way.
… …
1220 1222
1221The current reschedule callback, or C<0>, if this functionality is 1223The current reschedule callback, or C<0>, if this functionality is
1222switched off. Can be changed any time, but changes only take effect when 1224switched off. Can be changed any time, but changes only take effect when
1223the periodic timer fires or C<ev_periodic_again> is being called. 1225the periodic timer fires or C<ev_periodic_again> is being called.
1224 1226
1227=item ev_tstamp at [read-only]
1228
1229When active, contains the absolute time that the watcher is supposed to
1230trigger next.
1231
1225=back 1232=back
1226 1233
1227Example: Call a callback every hour, or, more precisely, whenever the 1234Example: Call a callback every hour, or, more precisely, whenever the
1228system clock is divisible by 3600. The callback invocation times have 1235system clock is divisible by 3600. The callback invocation times have
1229potentially a lot of jittering, but good long-term stability. 1236potentially a lot of jittering, but good long-term stability.
… …
2019 2026
2020=item w->stop () 2027=item w->stop ()
2021 2028
2022Stops the watcher if it is active. Again, no C<loop> argument. 2029Stops the watcher if it is active. Again, no C<loop> argument.
2023 2030
2024=item w->again () C<ev::timer>, C<ev::periodic> only 2031=item w->again () (C<ev::timer>, C<ev::periodic> only)
2025 2032
2026For C<ev::timer> and C<ev::periodic>, this invokes the corresponding 2033For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
2027C<ev_TYPE_again> function. 2034C<ev_TYPE_again> function.
2028 2035
2029=item w->sweep () C<ev::embed> only 2036=item w->sweep () (C<ev::embed> only)
2030 2037
2031Invokes C<ev_embed_sweep>. 2038Invokes C<ev_embed_sweep>.
2032 2039
2033=item w->update () C<ev::stat> only 2040=item w->update () (C<ev::stat> only)
2034 2041
2035Invokes C<ev_stat_stat>. 2042Invokes C<ev_stat_stat>.
2036 2043
2037=back 2044=back
2038 2045
… …
2058 } 2065 }
2059 2066
2060 2067
2061=head1 MACRO MAGIC 2068=head1 MACRO MAGIC
2062 2069
2063Libev can be compiled with a variety of options, the most fundemantal is 2070Libev can be compiled with a variety of options, the most fundamantal
2064C<EV_MULTIPLICITY>. This option determines whether (most) functions and 2071of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2065callbacks have an initial C<struct ev_loop *> argument. 2072functions and callbacks have an initial C<struct ev_loop *> argument.
2066 2073
2067To make it easier to write programs that cope with either variant, the 2074To make it easier to write programs that cope with either variant, the
2068following macros are defined: 2075following macros are defined:
2069 2076
2070=over 4 2077=over 4

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines