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

Comparing libev/ev.pod (file contents):
Revision 1.59 by root, Wed Nov 28 17:32:24 2007 UTC vs.
Revision 1.61 by root, Thu Nov 29 12:21:05 2007 UTC

… …
916=item ev_timer_again (loop) 916=item ev_timer_again (loop)
917 917
918This will act as if the timer timed out and restart it again if it is 918This will act as if the timer timed out and restart it again if it is
919repeating. The exact semantics are: 919repeating. The exact semantics are:
920 920
921If the timer is pending, its pending status is cleared.
922
921If the timer is started but nonrepeating, stop it. 923If the timer is started but nonrepeating, stop it (as if it timed out).
922 924
923If the timer is repeating, either start it if necessary (with the repeat 925If the timer is repeating, either start it if necessary (with the
924value), or reset the running timer to the repeat value. 926C<repeat> value), or reset the running timer to the C<repeat> value.
925 927
926This sounds a bit complicated, but here is a useful and typical 928This sounds a bit complicated, but here is a useful and typical
927example: Imagine you have a tcp connection and you want a so-called 929example: Imagine you have a tcp connection and you want a so-called idle
928idle timeout, that is, you want to be called when there have been, 930timeout, that is, you want to be called when there have been, say, 60
929say, 60 seconds of inactivity on the socket. The easiest way to do 931seconds of inactivity on the socket. The easiest way to do this is to
930this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling 932configure an C<ev_timer> with a C<repeat> value of C<60> and then call
931C<ev_timer_again> each time you successfully read or write some data. If 933C<ev_timer_again> each time you successfully read or write some data. If
932you go into an idle state where you do not expect data to travel on the 934you go into an idle state where you do not expect data to travel on the
933socket, you can stop the timer, and again will automatically restart it if 935socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
934need be. 936automatically restart it if need be.
935 937
936You can also ignore the C<after> value and C<ev_timer_start> altogether 938That means you can ignore the C<after> value and C<ev_timer_start>
937and only ever use the C<repeat> value: 939altogether and only ever use the C<repeat> value and C<ev_timer_again>:
938 940
939 ev_timer_init (timer, callback, 0., 5.); 941 ev_timer_init (timer, callback, 0., 5.);
940 ev_timer_again (loop, timer); 942 ev_timer_again (loop, timer);
941 ... 943 ...
942 timer->again = 17.; 944 timer->again = 17.;
943 ev_timer_again (loop, timer); 945 ev_timer_again (loop, timer);
944 ... 946 ...
945 timer->again = 10.; 947 timer->again = 10.;
946 ev_timer_again (loop, timer); 948 ev_timer_again (loop, timer);
947 949
948This is more efficient then stopping/starting the timer eahc time you want 950This is more slightly efficient then stopping/starting the timer each time
949to modify its timeout value. 951you want to modify its timeout value.
950 952
951=item ev_tstamp repeat [read-write] 953=item ev_tstamp repeat [read-write]
952 954
953The current C<repeat> value. Will be used each time the watcher times out 955The current C<repeat> value. Will be used each time the watcher times out
954or C<ev_timer_again> is called and determines the next timeout (if any), 956or C<ev_timer_again> is called and determines the next timeout (if any),
… …
1222The path does not need to exist: changing from "path exists" to "path does 1224The path does not need to exist: changing from "path exists" to "path does
1223not exist" is a status change like any other. The condition "path does 1225not exist" is a status change like any other. The condition "path does
1224not exist" is signified by the C<st_nlink> field being zero (which is 1226not exist" is signified by the C<st_nlink> field being zero (which is
1225otherwise always forced to be at least one) and all the other fields of 1227otherwise always forced to be at least one) and all the other fields of
1226the stat buffer having unspecified contents. 1228the stat buffer having unspecified contents.
1229
1230The path I<should> be absolute and I<must not> end in a slash. If it is
1231relative and your working directory changes, the behaviour is undefined.
1227 1232
1228Since there is no standard to do this, the portable implementation simply 1233Since there is no standard to do this, the portable implementation simply
1229calls C<stat (2)> regularly on the path to see if it changed somehow. You 1234calls C<stat (2)> regularly on the path to see if it changed somehow. You
1230can specify a recommended polling interval for this case. If you specify 1235can specify a recommended polling interval for this case. If you specify
1231a polling interval of C<0> (highly recommended!) then a I<suitable, 1236a polling interval of C<0> (highly recommended!) then a I<suitable,

Diff Legend

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