/usr/share/doc/liblwt-ocaml-dev/api/Lwt_ssl.html is in liblwt-ocaml-doc 2.4.3-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 | <!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.html">
<link rel="next" href="Lwt_text.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_ssl</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_react.html" title="Lwt_react">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Lwt_text.html" title="Lwt_text">Next</a>
</div>
<h1>Module <a href="type_Lwt_ssl.html">Lwt_ssl</a></h1>
<pre><span class="keyword">module</span> Lwt_ssl: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_ssl.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
OCaml-SSL integration<br>
</div>
<hr width="100%">
<pre><span id="TYPEsocket"><span class="keyword">type</span> <code class="type"></code>socket</span> </pre>
<div class="info ">
Wrapper for SSL sockets.
<p>
It is either a plain socket, either a real SSL socket.<br>
</div>
<pre><span id="VALssl_socket"><span class="keyword">val</span> ssl_socket</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> Ssl.socket option</code></pre><div class="info ">
Returns the underlying SSL socket used for this wrapper. If it
is a plain socket it returns <code class="code"><span class="constructor">None</span></code>.<br>
</div>
<pre><span id="VALssl_accept"><span class="keyword">val</span> ssl_accept</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> Ssl.context -> <a href="Lwt_ssl.html#TYPEsocket">socket</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALssl_connect"><span class="keyword">val</span> ssl_connect</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> Ssl.context -> <a href="Lwt_ssl.html#TYPEsocket">socket</a> <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALplain"><span class="keyword">val</span> plain</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> <a href="Lwt_ssl.html#TYPEsocket">socket</a></code></pre>
<pre><span id="VALembed_socket"><span class="keyword">val</span> embed_socket</span> : <code class="type"><a href="Lwt_unix.html#TYPEfile_descr">Lwt_unix.file_descr</a> -> Ssl.context -> <a href="Lwt_ssl.html#TYPEsocket">socket</a></code></pre>
<pre><span id="VALread"><span class="keyword">val</span> read</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> string -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALwrite"><span class="keyword">val</span> write</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> string -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALread_bytes"><span class="keyword">val</span> read_bytes</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> <a href="Lwt_bytes.html#TYPEt">Lwt_bytes.t</a> -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALwrite_bytes"><span class="keyword">val</span> write_bytes</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> <a href="Lwt_bytes.html#TYPEt">Lwt_bytes.t</a> -> int -> int -> int <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALwait_read"><span class="keyword">val</span> wait_read</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALwait_write"><span class="keyword">val</span> wait_write</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALshutdown"><span class="keyword">val</span> shutdown</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> Unix.shutdown_command -> unit</code></pre>
<pre><span id="VALclose"><span class="keyword">val</span> close</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</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_ssl.html#TYPEsocket">socket</a> -> <a href="Lwt_chan.html#TYPEout_channel">Lwt_chan.out_channel</a></code></pre>
<pre><span id="VALin_channel_of_descr"><span class="keyword">val</span> in_channel_of_descr</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> <a href="Lwt_chan.html#TYPEin_channel">Lwt_chan.in_channel</a></code></pre>
<pre><span id="VALssl_shutdown"><span class="keyword">val</span> ssl_shutdown</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> unit <a href="Lwt.html#TYPEt">Lwt.t</a></code></pre>
<pre><span id="VALabort"><span class="keyword">val</span> abort</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> exn -> unit</code></pre>
<pre><span id="VALis_ssl"><span class="keyword">val</span> is_ssl</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> bool</code></pre><div class="info ">
Are we using an SSL socket?<br>
</div>
<pre><span id="VALgetsockname"><span class="keyword">val</span> getsockname</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> Unix.sockaddr</code></pre>
<pre><span id="VALgetpeername"><span class="keyword">val</span> getpeername</span> : <code class="type"><a href="Lwt_ssl.html#TYPEsocket">socket</a> -> Unix.sockaddr</code></pre></body></html>
|