<!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_top.html">
<link rel="next" href="Lwt_daemon.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"><link title="Cooperative output channels" rel="Section" href="#2_Cooperativeoutputchannels">
<title>Lwt_chan</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_top.html" title="Lwt_top">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Lwt_daemon.html" title="Lwt_daemon">Next</a>
</div>
<h1>Module <a href="type_Lwt_chan.html">Lwt_chan</a></h1>
<pre><span class="keyword">module</span> Lwt_chan: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_chan.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Module <code class="code"><span class="constructor">Lwt_chan</span></code>: cooperative, <code class="code"><span class="constructor">Pervasives</span></code>-like, I/O functions<br>
</div>
<hr width="100%">
<br>
Note: the <a href="Lwt_io.html"><code class="code"><span class="constructor">Lwt_io</span></code></a> module deprecates this module.<br>
<pre><span id="TYPEin_channel"><span class="keyword">type</span> <code class="type"></code>in_channel</span> = <code class="type"><a href="Lwt_io.html#TYPEinput_channel">Lwt_io.input_channel</a></code> </pre>
<div class="info">
<h2 id="2_Cooperativeinputchannels">Cooperative input channels</h2><br>
</div>
<pre><span id="VALin_channel_of_descr"><span class="keyword">val</span> in_channel_of_descr</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> <a href="Lwt_chan.html#TYPEin_channel">in_channel</a></code></pre><pre><span id="VALmake_in_channel"><span class="keyword">val</span> make_in_channel</span> : <code class="type">?close:(unit -> unit <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> (string -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a>) -> <a href="Lwt_chan.html#TYPEin_channel">in_channel</a></code></pre><div class="info">
<code class="code">make_in_channel read</code> creates an input channel from the <code class="code">read</code>
function. <code class="code">read s ofs len</code> should (cooperatively) read <code class="code">len</code> bytes from
the source, and put them in <code class="code">s</code>, at offset <code class="code">ofs</code>, and return the number
of bytes effectively read. If provided, <code class="code">close</code> will be called by
<code class="code">close_in</code>. By default, <code class="code">close_in</code> does not do anything.<br>
</div>
<pre><span id="VALinput_line"><span class="keyword">val</span> input_line</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> string <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALinput_value"><span class="keyword">val</span> input_value</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> 'a <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALinput"><span class="keyword">val</span> input</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> string -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALreally_input"><span class="keyword">val</span> really_input</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> string -> int -> int -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALinput_char"><span class="keyword">val</span> input_char</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> char <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALinput_binary_int"><span class="keyword">val</span> input_binary_int</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALopen_in_gen"><span class="keyword">val</span> open_in_gen</span> : <code class="type">Unix.open_flag list -> int -> string -> <a href="Lwt_chan.html#TYPEin_channel">in_channel</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALopen_in"><span class="keyword">val</span> open_in</span> : <code class="type">string -> <a href="Lwt_chan.html#TYPEin_channel">in_channel</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALclose_in"><span class="keyword">val</span> close_in</span> : <code class="type"><a href="Lwt_chan.html#TYPEin_channel">in_channel</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><br>
<h2 id="2_Cooperativeoutputchannels">Cooperative output channels</h2><br>
<pre><span id="TYPEout_channel"><span class="keyword">type</span> <code class="type"></code>out_channel</span> = <code class="type"><a href="Lwt_io.html#TYPEoutput_channel">Lwt_io.output_channel</a></code> </pre>
<pre><span id="VALout_channel_of_descr"><span class="keyword">val</span> out_channel_of_descr</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> <a href="Lwt_chan.html#TYPEout_channel">out_channel</a></code></pre><pre><span id="VALmake_out_channel"><span class="keyword">val</span> make_out_channel</span> : <code class="type">?close:(unit -> unit <a href="Lwt.html#TYPEt">Lwt.t</a>) -><br> (string -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a>) -> <a href="Lwt_chan.html#TYPEout_channel">out_channel</a></code></pre><div class="info">
<code class="code">make_out_channel write</code> creates an output channel from the <code class="code">write</code>
function. <code class="code">write s ofs len</code> should (cooperatively) write <code class="code">len</code> bytes from
<code class="code">s</code>, starting at offset <code class="code">ofs</code>, to the backend, and return the number of
bytes effectively written. If provided, <code class="code">close</code> will be called by
<code class="code">close_out</code>. By default, <code class="code">close_out</code> does not do anything.<br>
</div>
<pre><span id="VALoutput"><span class="keyword">val</span> output</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> string -> int -> int -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALflush"><span class="keyword">val</span> flush</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALoutput_string"><span class="keyword">val</span> output_string</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> string -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALoutput_value"><span class="keyword">val</span> output_value</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> 'a -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALoutput_char"><span class="keyword">val</span> output_char</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> char -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALoutput_binary_int"><span class="keyword">val</span> output_binary_int</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> int -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALopen_out_gen"><span class="keyword">val</span> open_out_gen</span> : <code class="type">Unix.open_flag list -> int -> string -> <a href="Lwt_chan.html#TYPEout_channel">out_channel</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALopen_out"><span class="keyword">val</span> open_out</span> : <code class="type">string -> <a href="Lwt_chan.html#TYPEout_channel">out_channel</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALclose_out"><span class="keyword">val</span> close_out</span> : <code class="type"><a href="Lwt_chan.html#TYPEout_channel">out_channel</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre><pre><span id="VALopen_connection"><span class="keyword">val</span> open_connection</span> : <code class="type">Unix.sockaddr -> (<a href="Lwt_chan.html#TYPEin_channel">in_channel</a> * <a href="Lwt_chan.html#TYPEout_channel">out_channel</a>) <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre></body></html>
