<!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="next" href="Lwt_list.html"> <link rel="Up" href="index.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"><title>Lwt_condition</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> <a class="post" href="Lwt_list.html" title="Lwt_list">Next</a> </div> <h1>Module <a href="type_Lwt_condition.html">Lwt_condition</a></h1> <pre><span class="keyword">module</span> Lwt_condition: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_condition.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> Conditions<br> </div> <hr width="100%"> <br> Condition variables to synchronize between threads.<br> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre> <div class="info"> Condition variable type. The type parameter denotes the type of value propagated from notifier to waiter.<br> </div> <pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">unit -> 'a <a href="Lwt_condition.html#TYPEt">t</a></code></pre><div class="info"> <code class="code">create ()</code> creates a new condition variable.<br> </div> <pre><span id="VALwait"><span class="keyword">val</span> wait</span> : <code class="type">?mutex:<a href="Lwt_mutex.html#TYPEt">Lwt_mutex.t</a> -> 'a <a href="Lwt_condition.html#TYPEt">t</a> -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><div class="info"> <code class="code">wait mutex condvar</code> will cause the current thread to block, awaiting notification for a condition variable, <code class="code">condvar</code>. If provided, the <code class="code">mutex</code> must have been previously locked (within the scope of <code class="code"><span class="constructor">Lwt_mutex</span>.with_lock</code>, for example) and is temporarily unlocked until the condition is notified. Upon notification, <code class="code">mutex</code> is re-locked before <code class="code">wait</code> returns and the thread's activity is resumed. When the awaited condition is notified, the value parameter passed to <code class="code">notify</code> is returned.<br> </div> <pre><span id="VALsignal"><span class="keyword">val</span> signal</span> : <code class="type">'a <a href="Lwt_condition.html#TYPEt">t</a> -> 'a -> unit</code></pre><div class="info"> <code class="code">signal condvar value</code> notifies that a condition is ready. A single waiting thread will be awoken and will receive the notification value which will be returned from <code class="code">wait</code>. Note that condition notification is not "sticky", i.e. if there is no waiter when <code class="code">notify</code> is called, the notification will be missed and the value discarded.<br> </div> <pre><span id="VALbroadcast"><span class="keyword">val</span> broadcast</span> : <code class="type">'a <a href="Lwt_condition.html#TYPEt">t</a> -> 'a -> unit</code></pre><div class="info"> <code class="code">broadcast condvar value</code> notifies all waiting threads. Each will be awoken in turn and will receive the same notification value.<br> </div> </body></html>