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

Comparing libev/ev.pod (file contents):
Revision 1.84 by root, Wed Dec 12 22:26:37 2007 UTC vs.
Revision 1.88 by ayin, Tue Dec 18 13:06:18 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.
402Destroys the default loop again (frees all memory and kernel state 404Destroys the default loop again (frees all memory and kernel state
403etc.). None of the active event watchers will be stopped in the normal 405etc.). None of the active event watchers will be stopped in the normal
404sense, so e.g. C<ev_is_active> might still return true. It is your 406sense, so e.g. C<ev_is_active> might still return true. It is your
405responsibility to either stop all watchers cleanly yoursef I<before> 407responsibility to either stop all watchers cleanly yoursef I<before>
406calling this function, or cope with the fact afterwards (which is usually 408calling this function, or cope with the fact afterwards (which is usually
407the easiest thing, youc na just ignore the watchers and/or C<free ()> them 409the easiest thing, you can just ignore the watchers and/or C<free ()> them
408for example). 410for example).
411
412Note that certain global state, such as signal state, will not be freed by
413this function, and related watchers (such as signal and child watchers)
414would need to be stopped manually.
415
416In general it is not advisable to call this function except in the
417rare occasion where you really need to free e.g. the signal handling
418pipe fds. If you need dynamically allocated loops it is better to use
419C<ev_loop_new> and C<ev_loop_destroy>).
409 420
410=item ev_loop_destroy (loop) 421=item ev_loop_destroy (loop)
411 422
412Like C<ev_default_destroy>, but destroys an event loop created by an 423Like C<ev_default_destroy>, but destroys an event loop created by an
413earlier call to C<ev_loop_new>. 424earlier call to C<ev_loop_new>.
1220 1231
1221The current reschedule callback, or C<0>, if this functionality is 1232The current reschedule callback, or C<0>, if this functionality is
1222switched off. Can be changed any time, but changes only take effect when 1233switched off. Can be changed any time, but changes only take effect when
1223the periodic timer fires or C<ev_periodic_again> is being called. 1234the periodic timer fires or C<ev_periodic_again> is being called.
1224 1235
1236=item ev_tstamp at [read-only]
1237
1238When active, contains the absolute time that the watcher is supposed to
1239trigger next.
1240
1225=back 1241=back
1226 1242
1227Example: Call a callback every hour, or, more precisely, whenever the 1243Example: Call a callback every hour, or, more precisely, whenever the
1228system clock is divisible by 3600. The callback invocation times have 1244system clock is divisible by 3600. The callback invocation times have
1229potentially a lot of jittering, but good long-term stability. 1245potentially a lot of jittering, but good long-term stability.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines