<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Lwt_react.E.html">
<link rel="Up" href="Lwt_react.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Lwt_condition" rel="Chapter" href="Lwt_condition.html">
<link title="Lwt_list" rel="Chapter" href="Lwt_list.html">
<link title="Lwt" rel="Chapter" href="Lwt.html">
<link title="Lwt_mutex" rel="Chapter" href="Lwt_mutex.html">
<link title="Lwt_mvar" rel="Chapter" href="Lwt_mvar.html">
<link title="Lwt_pool" rel="Chapter" href="Lwt_pool.html">
<link title="Lwt_sequence" rel="Chapter" href="Lwt_sequence.html">
<link title="Lwt_stream" rel="Chapter" href="Lwt_stream.html">
<link title="Lwt_switch" rel="Chapter" href="Lwt_switch.html">
<link title="Lwt_util" rel="Chapter" href="Lwt_util.html">
<link title="Lwt_pqueue" rel="Chapter" href="Lwt_pqueue.html">
<link title="Lwt_lib" rel="Chapter" href="Lwt_lib.html">
<link title="Lwt_glib" rel="Chapter" href="Lwt_glib.html">
<link title="Lwt_preemptive" rel="Chapter" href="Lwt_preemptive.html">
<link title="Lwt_event" rel="Chapter" href="Lwt_event.html">
<link title="Lwt_signal" rel="Chapter" href="Lwt_signal.html">
<link title="Lwt_react" rel="Chapter" href="Lwt_react.html">
<link title="Lwt_ssl" rel="Chapter" href="Lwt_ssl.html">
<link title="Lwt_text" rel="Chapter" href="Lwt_text.html">
<link title="Lwt_term" rel="Chapter" href="Lwt_term.html">
<link title="Lwt_read_line" rel="Chapter" href="Lwt_read_line.html">
<link title="Lwt_top" rel="Chapter" href="Lwt_top.html">
<link title="Lwt_chan" rel="Chapter" href="Lwt_chan.html">
<link title="Lwt_daemon" rel="Chapter" href="Lwt_daemon.html">
<link title="Lwt_gc" rel="Chapter" href="Lwt_gc.html">
<link title="Lwt_io" rel="Chapter" href="Lwt_io.html">
<link title="Lwt_log" rel="Chapter" href="Lwt_log.html">
<link title="Lwt_main" rel="Chapter" href="Lwt_main.html">
<link title="Lwt_process" rel="Chapter" href="Lwt_process.html">
<link title="Lwt_throttle" rel="Chapter" href="Lwt_throttle.html">
<link title="Lwt_timeout" rel="Chapter" href="Lwt_timeout.html">
<link title="Lwt_unix" rel="Chapter" href="Lwt_unix.html">
<link title="Lwt_sys" rel="Chapter" href="Lwt_sys.html">
<link title="Lwt_engine" rel="Chapter" href="Lwt_engine.html">
<link title="Lwt_bytes" rel="Chapter" href="Lwt_bytes.html">
<link title="Pa_lwt" rel="Chapter" href="Pa_lwt.html">
<link title="Pa_lwt_log" rel="Chapter" href="Pa_lwt_log.html"><link title="Monadic interface" rel="Section" href="#6_Monadicinterface">
<link title="Lwt-specific utilities" rel="Section" href="#6_Lwtspecificutilities">
<link title="Threaded versions of React transformation functions" rel="Section" href="#6_ThreadedversionsofReacttransformationfunctions">
<title>Lwt_react.S</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_react.E.html" title="Lwt_react.E">Previous</a>
<a class="up" href="Lwt_react.html" title="Lwt_react">Up</a>
</div>
<h1>Module <a href="type_Lwt_react.S.html">Lwt_react.S</a></h1>
<pre><span class="keyword">module</span> S: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_react.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><hr width="100%">
<pre><span class="keyword">include</span> React.S</pre>
<br>
<h6 id="6_Monadicinterface">Monadic interface</h6><br>
<pre><span id="VALreturn"><span class="keyword">val</span> return</span> : <code class="type">'a -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><div class="info">
Same as <code class="code">const</code>.<br>
</div>
<pre><span id="VALbind"><span class="keyword">val</span> bind</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> ('a -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a>) -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><div class="info">
<code class="code">bind ?eq s f</code> is initially <code class="code">f x</code> where <code class="code">x</code> is the current
value of <code class="code">s</code>. Each time <code class="code">s</code> changes to a new value <code class="code">y</code>, <code class="code">bind
signal f</code> is set to <code class="code">f y</code>, until the next change of
<code class="code">signal</code>.<br>
</div>
<pre><span id="VALbind_s"><span class="keyword">val</span> bind_s</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> ('a -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info">
Same as <a href="Lwt_react.S.html#VALbind"><code class="code"><span class="constructor">Lwt_react</span>.<span class="constructor">S</span>.bind</code></a> except that <code class="code">f</code> returns a thread. Calls to <code class="code">f</code>
are serialized.<br>
</div>
<br>
<h6 id="6_Lwtspecificutilities">Lwt-specific utilities</h6><br>
<pre><span id="VALwith_finaliser"><span class="keyword">val</span> with_finaliser</span> : <code class="type">(unit -> unit) -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><div class="info">
<code class="code">with_finaliser f s</code> returns a signal <code class="code">s'</code> which behave as
<code class="code">s</code>, except that <code class="code">f</code> is called when <code class="code">s'</code> is garbage
collected.<br>
</div>
<pre><span id="VALlimit"><span class="keyword">val</span> limit</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> (unit -> unit <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><div class="info">
<code class="code">limit f s</code> limits the rate of <code class="code">s</code> update with <code class="code">f</code>.
<p>
For example, to limit it to 1 per second, you can use: <code class="code">limit
(<span class="keyword">fun</span> () <span class="keywordsign">-></span> <span class="constructor">Lwt_unix</span>.sleep 1.0) s</code>.<br>
</div>
<pre><span id="VALkeep"><span class="keyword">val</span> keep</span> : <code class="type">'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> unit</code></pre><div class="info">
<code class="code">keep s</code> keeps a reference to <code class="code">s</code> so it will never be garbage
collected.<br>
</div>
<br>
<h6 id="6_ThreadedversionsofReacttransformationfunctions">Threaded versions of React transformation functions</h6><br>
<br>
The following functions behave as their <code class="code"><span class="constructor">React</span></code> counterpart,
except that they takes functions that may yield.
<p>
The <code class="code">_s</code> suffix means that calls are serialized.<br>
<pre><span id="VALapp_s"><span class="keyword">val</span> app_s</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> ('a -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALmap_s"><span class="keyword">val</span> map_s</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> ('a -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALfilter_s"><span class="keyword">val</span> filter_s</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> ('a -> bool <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALfmap_s"><span class="keyword">val</span> fmap_s</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> ('a -> 'b option <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'b -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALdiff_s"><span class="keyword">val</span> diff_s</span> : <code class="type">('a -> 'a -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEevent">Lwt_react.event</a></code></pre><pre><span id="VALsample_s"><span class="keyword">val</span> sample_s</span> : <code class="type">('b -> 'a -> 'c <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'b <a href="Lwt_react.html#TYPEevent">Lwt_react.event</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'c <a href="Lwt_react.html#TYPEevent">Lwt_react.event</a></code></pre><pre><span id="VALaccum_s"><span class="keyword">val</span> accum_s</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> ('a -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a>) <a href="Lwt_react.html#TYPEevent">Lwt_react.event</a> -> 'a -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><pre><span id="VALfold_s"><span class="keyword">val</span> fold_s</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> ('a -> 'b -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a -> 'b <a href="Lwt_react.html#TYPEevent">Lwt_react.event</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a></code></pre><pre><span id="VALmerge_s"><span class="keyword">val</span> merge_s</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> ('a -> 'b -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> list -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl1_s"><span class="keyword">val</span> l1_s</span> : <code class="type">?eq:('b -> 'b -> bool) -><br> ('a -> 'b <a href="Lwt.html#TYPEt">Lwt.t</a>) -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl2_s"><span class="keyword">val</span> l2_s</span> : <code class="type">?eq:('c -> 'c -> bool) -><br> ('a -> 'b -> 'c <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'c <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl3_s"><span class="keyword">val</span> l3_s</span> : <code class="type">?eq:('d -> 'd -> bool) -><br> ('a -> 'b -> 'c -> 'd <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'c <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'd <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl4_s"><span class="keyword">val</span> l4_s</span> : <code class="type">?eq:('e -> 'e -> bool) -><br> ('a -> 'b -> 'c -> 'd -> 'e <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'c <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'd <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'e <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl5_s"><span class="keyword">val</span> l5_s</span> : <code class="type">?eq:('f -> 'f -> bool) -><br> ('a -> 'b -> 'c -> 'd -> 'e -> 'f <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'c <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'd <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'e <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'f <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALl6_s"><span class="keyword">val</span> l6_s</span> : <code class="type">?eq:('g -> 'g -> bool) -><br> ('a -> 'b -> 'c -> 'd -> 'e -> 'f -> 'g <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'b <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'c <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'd <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -><br> 'e <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'f <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'g <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALrun_s"><span class="keyword">val</span> run_s</span> : <code class="type">?eq:('a -> 'a -> bool) -><br> 'a <a href="Lwt.html#TYPEt">Lwt.t</a> <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> -> 'a <a href="Lwt_react.html#TYPEsignal">Lwt_react.signal</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre></body></html>
