<!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="Import.html">
<link rel="next" href="In_thread.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="Async_print" rel="Chapter" href="Async_print.html">
<link title="Async_sys" rel="Chapter" href="Async_sys.html">
<link title="Epoll_file_descr_watcher" rel="Chapter" href="Epoll_file_descr_watcher.html">
<link title="Fd" rel="Chapter" href="Fd.html">
<link title="Fd_by_descr" rel="Chapter" href="Fd_by_descr.html">
<link title="File_descr_watcher_intf" rel="Chapter" href="File_descr_watcher_intf.html">
<link title="Import" rel="Chapter" href="Import.html">
<link title="Interruptor" rel="Chapter" href="Interruptor.html">
<link title="In_thread" rel="Chapter" href="In_thread.html">
<link title="Io_stats" rel="Chapter" href="Io_stats.html">
<link title="Process" rel="Chapter" href="Process.html">
<link title="Raw_fd" rel="Chapter" href="Raw_fd.html">
<link title="Raw_scheduler" rel="Chapter" href="Raw_scheduler.html">
<link title="Raw_signal_manager" rel="Chapter" href="Raw_signal_manager.html">
<link title="Reader" rel="Chapter" href="Reader.html">
<link title="Read_write" rel="Chapter" href="Read_write.html">
<link title="Scheduler" rel="Chapter" href="Scheduler.html">
<link title="Select_file_descr_watcher" rel="Chapter" href="Select_file_descr_watcher.html">
<link title="Shutdown" rel="Chapter" href="Shutdown.html">
<link title="Signal" rel="Chapter" href="Signal.html">
<link title="Signal_manager" rel="Chapter" href="Signal_manager.html">
<link title="Std" rel="Chapter" href="Std.html">
<link title="Syscall" rel="Chapter" href="Syscall.html">
<link title="Thread_pool" rel="Chapter" href="Thread_pool.html">
<link title="Thread_safe" rel="Chapter" href="Thread_safe.html">
<link title="Thread_safe_pipe" rel="Chapter" href="Thread_safe_pipe.html">
<link title="Unix_syscalls" rel="Chapter" href="Unix_syscalls.html">
<link title="Writer" rel="Chapter" href="Writer.html"><title>Interruptor</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Import.html" title="Import">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="In_thread.html" title="In_thread">Next</a>
</div>
<h1>Module <a href="type_Interruptor.html">Interruptor</a></h1>
<pre><span class="keyword">module</span> Interruptor: <code class="code">sig</code> <a href="Interruptor.html">..</a> <code class="code">end</code></pre><div class="info module top">
An interruptor provides a file descriptor that can be used to cause a
file-descr-watcher to detect the file descriptor is ready for reading. We use an
interruptor when a thread needs the async scheduler to service a request.<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<pre><span class="keyword">include</span> Invariant.S</pre>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">create_fd:(<a href="Raw_fd.Kind.html#TYPEt">Raw_fd.Kind.t</a> -><br> Core.Std.Unix.File_descr.t -> Core.Std.Info.t -> Raw_fd.t) -><br> <a href="Interruptor.html#TYPEt">t</a></code></pre>
<pre><span id="VALread_fd"><span class="keyword">val</span> read_fd</span> : <code class="type"><a href="Interruptor.html#TYPEt">t</a> -> Raw_fd.t</code></pre>
<pre><span id="VALthread_safe_interrupt"><span class="keyword">val</span> thread_safe_interrupt</span> : <code class="type"><a href="Interruptor.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">thread_safe_interrupt t</code> causes <code class="code">read_fd t</code> to become ready for reading.<br>
</div>
<pre><span id="VALclear"><span class="keyword">val</span> clear</span> : <code class="type"><a href="Interruptor.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">clear t</code> causes <code class="code">read_fd t</code> to become not ready for reading. It is guaranteed that
any calls to <code class="code">thread_safe_interrupt</code> after <code class="code">clear t</code> returns (and prior to another
call to <code class="code">clear t</code>) will cause <code class="code">read_fd</code> to become ready for reading.<br>
</div>
<pre><span id="VALsexp_of_t"><span class="keyword">val</span> sexp_of_t</span> : <code class="type"><a href="Interruptor.html#TYPEt">t</a> -> Sexplib.Sexp.t</code></pre><br>
<code class="code">thread_safe_interrupt t</code> causes <code class="code">read_fd t</code> to become ready for reading.<br>
<br>
<code class="code">clear t</code> causes <code class="code">read_fd t</code> to become not ready for reading. It is guaranteed that
any calls to <code class="code">thread_safe_interrupt</code> after <code class="code">clear t</code> returns (and prior to another
call to <code class="code">clear t</code>) will cause <code class="code">read_fd</code> to become ready for reading.<br>
</body></html>
