<!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">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Terminfo.html">
<link rel="next" href="ThreadUnix.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 modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Arg_helper" rel="Chapter" href="Arg_helper.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Ast_helper" rel="Chapter" href="Ast_helper.html">
<link title="Ast_invariants" rel="Chapter" href="Ast_invariants.html">
<link title="Ast_iterator" rel="Chapter" href="Ast_iterator.html">
<link title="Ast_mapper" rel="Chapter" href="Ast_mapper.html">
<link title="Asttypes" rel="Chapter" href="Asttypes.html">
<link title="Attr_helper" rel="Chapter" href="Attr_helper.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Builtin_attributes" rel="Chapter" href="Builtin_attributes.html">
<link title="Bytes" rel="Chapter" href="Bytes.html">
<link title="BytesLabels" rel="Chapter" href="BytesLabels.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html">
<link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html">
<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Config" rel="Chapter" href="Config.html">
<link title="Consistbl" rel="Chapter" href="Consistbl.html">
<link title="Depend" rel="Chapter" href="Depend.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Docstrings" rel="Chapter" href="Docstrings.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Ephemeron" rel="Chapter" href="Ephemeron.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Float" rel="Chapter" href="Float.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Identifiable" rel="Chapter" href="Identifiable.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexer" rel="Chapter" href="Lexer.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Location" rel="Chapter" href="Location.html">
<link title="Longident" rel="Chapter" href="Longident.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="Misc" rel="Chapter" href="Misc.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Numbers" rel="Chapter" href="Numbers.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parse" rel="Chapter" href="Parse.html">
<link title="Parser" rel="Chapter" href="Parser.html">
<link title="Parsetree" rel="Chapter" href="Parsetree.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Pparse" rel="Chapter" href="Pparse.html">
<link title="Pprintast" rel="Chapter" href="Pprintast.html">
<link title="Printast" rel="Chapter" href="Printast.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Profile" rel="Chapter" href="Profile.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Seq" rel="Chapter" href="Seq.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Simplif" rel="Chapter" href="Simplif.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Spacetime" rel="Chapter" href="Spacetime.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Strongly_connected_components" rel="Chapter" href="Strongly_connected_components.html">
<link title="Syntaxerr" rel="Chapter" href="Syntaxerr.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Targetint" rel="Chapter" href="Targetint.html">
<link title="Tbl" rel="Chapter" href="Tbl.html">
<link title="Terminfo" rel="Chapter" href="Terminfo.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Typemod" rel="Chapter" href="Typemod.html">
<link title="Uchar" rel="Chapter" href="Uchar.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Warnings" rel="Chapter" href="Warnings.html">
<link title="Weak" rel="Chapter" href="Weak.html"><link title="Thread creation and termination" rel="Section" href="#1_Threadcreationandtermination">
<link title="Suspending threads" rel="Section" href="#1_Suspendingthreads">
<title>Thread</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Terminfo.html" title="Terminfo">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="ThreadUnix.html" title="ThreadUnix">Next</a>
</div>
<h1>Module <a href="type_Thread.html">Thread</a></h1>
<pre><span id="MODULEThread"><span class="keyword">module</span> Thread</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Thread.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
<div class="info-desc">
<p>Lightweight threads.</p>
</div>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
<div class="info-desc">
<p>The type of thread handles.</p>
</div>
</div>
<h2 id="1_Threadcreationandtermination">Thread creation and termination</h2>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">('a -> 'b) -> 'a -> <a href="Thread.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code"><span class="constructor">Thread</span>.create funct arg</code> creates a new thread of control,
in which the function application <code class="code">funct arg</code>
is executed concurrently with the other threads of the program.
The application of <code class="code"><span class="constructor">Thread</span>.create</code>
returns the handle of the newly created thread.
The new thread terminates when the application <code class="code">funct arg</code>
returns, either normally or by raising an uncaught exception.
In the latter case, the exception is printed on standard error,
but not propagated back to the parent thread. Similarly, the
result of the application <code class="code">funct arg</code> is discarded and not
directly accessible to the parent thread.</p>
</div>
</div>
<pre><span id="VALself"><span class="keyword">val</span> self</span> : <code class="type">unit -> <a href="Thread.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Return the thread currently executing.</p>
</div>
</div>
<pre><span id="VALid"><span class="keyword">val</span> id</span> : <code class="type"><a href="Thread.html#TYPEt">t</a> -> int</code></pre><div class="info ">
<div class="info-desc">
<p>Return the identifier of the given thread. A thread identifier
is an integer that identifies uniquely the thread.
It can be used to build data structures indexed by threads.</p>
</div>
</div>
<pre><span id="VALexit"><span class="keyword">val</span> exit</span> : <code class="type">unit -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Terminate prematurely the currently executing thread.</p>
</div>
</div>
<pre><span id="VALkill"><span class="keyword">val</span> kill</span> : <code class="type"><a href="Thread.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Terminate prematurely the thread whose handle is given.
This functionality is available only with bytecode-level threads.</p>
</div>
</div>
<h2 id="1_Suspendingthreads">Suspending threads</h2>
<pre><span id="VALdelay"><span class="keyword">val</span> delay</span> : <code class="type">float -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">delay d</code> suspends the execution of the calling thread for
<code class="code">d</code> seconds. The other program threads continue to run during
this time.</p>
</div>
</div>
<pre><span id="VALjoin"><span class="keyword">val</span> join</span> : <code class="type"><a href="Thread.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">join th</code> suspends the execution of the calling thread
until the thread <code class="code">th</code> has terminated.</p>
</div>
</div>
<pre><span id="VALwait_read"><span class="keyword">val</span> wait_read</span> : <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>See <a href="Thread.html#VALwait_write"><code class="code"><span class="constructor">Thread</span>.wait_write</code></a>.</p>
</div>
</div>
<pre><span id="VALwait_write"><span class="keyword">val</span> wait_write</span> : <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Suspend the execution of the calling thread until at least
one character or EOF is available for reading (<a href="Thread.html#VALwait_read"><code class="code"><span class="constructor">Thread</span>.wait_read</code></a>) or
one character can be written without blocking (<code class="code">wait_write</code>)
on the given Unix file descriptor.</p>
</div>
</div>
<pre><span id="VALwait_timed_read"><span class="keyword">val</span> wait_timed_read</span> : <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> -> float -> bool</code></pre><div class="info ">
<div class="info-desc">
<p>See <a href="Thread.html#VALwait_timed_write"><code class="code"><span class="constructor">Thread</span>.wait_timed_write</code></a>.</p>
</div>
</div>
<pre><span id="VALwait_timed_write"><span class="keyword">val</span> wait_timed_write</span> : <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> -> float -> bool</code></pre><div class="info ">
<div class="info-desc">
<p>Same as <a href="Thread.html#VALwait_read"><code class="code"><span class="constructor">Thread</span>.wait_read</code></a> and <a href="Thread.html#VALwait_write"><code class="code"><span class="constructor">Thread</span>.wait_write</code></a>, but wait for at most
the amount of time given as second argument (in seconds).
Return <code class="code"><span class="keyword">true</span></code> if the file descriptor is ready for input/output
and <code class="code"><span class="keyword">false</span></code> if the timeout expired.</p>
</div>
</div>
<pre><span id="VALselect"><span class="keyword">val</span> select</span> : <code class="type"><a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list -><br> <a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list -><br> <a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list -><br> float -> <a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list * <a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list * <a href="Unix.html#TYPEfile_descr">Unix.file_descr</a> list</code></pre><div class="info ">
<div class="info-desc">
<p>Suspend the execution of the calling thread until input/output
becomes possible on the given Unix file descriptors.
The arguments and results have the same meaning as for
<a href="Unix.html#VALselect"><code class="code"><span class="constructor">Unix</span>.select</code></a>.</p>
</div>
</div>
<pre><span id="VALwait_pid"><span class="keyword">val</span> wait_pid</span> : <code class="type">int -> int * <a href="Unix.html#TYPEprocess_status">Unix.process_status</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">wait_pid p</code> suspends the execution of the calling thread
until the Unix process specified by the process identifier <code class="code">p</code>
terminates. A pid <code class="code">p</code> of <code class="code">-1</code> means wait for any child.
A pid of <code class="code">0</code> means wait for any child in the same process group
as the current process. Negative pid arguments represent
process groups. Returns the pid of the child caught and
its termination status, as per <a href="Unix.html#VALwait"><code class="code"><span class="constructor">Unix</span>.wait</code></a>.</p>
</div>
</div>
<pre><span id="VALwait_signal"><span class="keyword">val</span> wait_signal</span> : <code class="type">int list -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">wait_signal sigs</code> suspends the execution of the calling thread
until the process receives one of the signals specified in the
list <code class="code">sigs</code>. It then returns the number of the signal received.
Signal handlers attached to the signals in <code class="code">sigs</code> will not
be invoked. Do not call <code class="code">wait_signal</code> concurrently
from several threads on the same signals.</p>
</div>
</div>
<pre><span id="VALyield"><span class="keyword">val</span> yield</span> : <code class="type">unit -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Re-schedule the calling thread without suspending it.
This function can be used to give scheduling hints,
telling the scheduler that now is a good time to
switch to other threads.</p>
</div>
</div>
</body></html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
fb18813323b88f9a6e869238ab603257
>
files
>
245
