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

Comparing libev/ev.html (file contents):
Revision 1.60 by root, Wed Nov 28 18:29:29 2007 UTC vs.
Revision 1.61 by root, Thu Nov 29 12:21:21 2007 UTC

… …
4<head> 4<head>
5 <title>libev</title> 5 <title>libev</title>
6 <meta name="description" content="Pod documentation for libev" /> 6 <meta name="description" content="Pod documentation for libev" />
7 <meta name="inputfile" content="&lt;standard input&gt;" /> 7 <meta name="inputfile" content="&lt;standard input&gt;" />
8 <meta name="outputfile" content="&lt;standard output&gt;" /> 8 <meta name="outputfile" content="&lt;standard output&gt;" />
9 <meta name="created" content="Wed Nov 28 19:29:25 2007" /> 9 <meta name="created" content="Thu Nov 29 13:21:20 2007" />
10 <meta name="generator" content="Pod::Xhtml 1.57" /> 10 <meta name="generator" content="Pod::Xhtml 1.57" />
11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> 11<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
12<body> 12<body>
13<div class="pod"> 13<div class="pod">
14<!-- INDEX START --> 14<!-- INDEX START -->
… …
952 </dd> 952 </dd>
953 <dt>ev_timer_again (loop)</dt> 953 <dt>ev_timer_again (loop)</dt>
954 <dd> 954 <dd>
955 <p>This will act as if the timer timed out and restart it again if it is 955 <p>This will act as if the timer timed out and restart it again if it is
956repeating. The exact semantics are:</p> 956repeating. The exact semantics are:</p>
957 <p>If the timer is pending, its pending status is cleared.</p>
957 <p>If the timer is started but nonrepeating, stop it.</p> 958 <p>If the timer is started but nonrepeating, stop it (as if it timed out).</p>
958 <p>If the timer is repeating, either start it if necessary (with the repeat 959 <p>If the timer is repeating, either start it if necessary (with the
959value), or reset the running timer to the repeat value.</p> 960<code>repeat</code> value), or reset the running timer to the <code>repeat</code> value.</p>
960 <p>This sounds a bit complicated, but here is a useful and typical 961 <p>This sounds a bit complicated, but here is a useful and typical
961example: Imagine you have a tcp connection and you want a so-called 962example: Imagine you have a tcp connection and you want a so-called idle
962idle timeout, that is, you want to be called when there have been, 963timeout, that is, you want to be called when there have been, say, 60
963say, 60 seconds of inactivity on the socket. The easiest way to do 964seconds of inactivity on the socket. The easiest way to do this is to
964this is to configure an <code>ev_timer</code> with <code>after</code>=<code>repeat</code>=<code>60</code> and calling 965configure an <code>ev_timer</code> with a <code>repeat</code> value of <code>60</code> and then call
965<code>ev_timer_again</code> each time you successfully read or write some data. If 966<code>ev_timer_again</code> each time you successfully read or write some data. If
966you go into an idle state where you do not expect data to travel on the 967you go into an idle state where you do not expect data to travel on the
967socket, you can stop the timer, and again will automatically restart it if 968socket, you can <code>ev_timer_stop</code> the timer, and <code>ev_timer_again</code> will
968need be.</p> 969automatically restart it if need be.</p>
969 <p>You can also ignore the <code>after</code> value and <code>ev_timer_start</code> altogether 970 <p>That means you can ignore the <code>after</code> value and <code>ev_timer_start</code>
970and only ever use the <code>repeat</code> value:</p> 971altogether and only ever use the <code>repeat</code> value and <code>ev_timer_again</code>:</p>
971<pre> ev_timer_init (timer, callback, 0., 5.); 972<pre> ev_timer_init (timer, callback, 0., 5.);
972 ev_timer_again (loop, timer); 973 ev_timer_again (loop, timer);
973 ... 974 ...
974 timer-&gt;again = 17.; 975 timer-&gt;again = 17.;
975 ev_timer_again (loop, timer); 976 ev_timer_again (loop, timer);
976 ... 977 ...
977 timer-&gt;again = 10.; 978 timer-&gt;again = 10.;
978 ev_timer_again (loop, timer); 979 ev_timer_again (loop, timer);
979 980
980</pre> 981</pre>
981 <p>This is more efficient then stopping/starting the timer eahc time you want 982 <p>This is more slightly efficient then stopping/starting the timer each time
982to modify its timeout value.</p> 983you want to modify its timeout value.</p>
983 </dd> 984 </dd>
984 <dt>ev_tstamp repeat [read-write]</dt> 985 <dt>ev_tstamp repeat [read-write]</dt>
985 <dd> 986 <dd>
986 <p>The current <code>repeat</code> value. Will be used each time the watcher times out 987 <p>The current <code>repeat</code> value. Will be used each time the watcher times out
987or <code>ev_timer_again</code> is called and determines the next timeout (if any), 988or <code>ev_timer_again</code> is called and determines the next timeout (if any),

Diff Legend

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