<!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 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="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Unixqueue_pollset" rel="Chapter" href="Unixqueue_pollset.html">
<link title="Unixqueue_select" rel="Chapter" href="Unixqueue_select.html">
<link title="Uq_resolver" rel="Chapter" href="Uq_resolver.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Uq_io" rel="Chapter" href="Uq_io.html">
<link title="Uq_lwt" rel="Chapter" href="Uq_lwt.html">
<link title="Uq_libevent" rel="Chapter" href="Uq_libevent.html">
<link title="Uq_mt" rel="Chapter" href="Uq_mt.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Equeue_howto" rel="Chapter" href="Equeue_howto.html">
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
<link title="Https_client" rel="Chapter" href="Https_client.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Netcamlbox" rel="Chapter" href="Netcamlbox.html">
<link title="Netcgi_apache" rel="Chapter" href="Netcgi_apache.html">
<link title="Netcgi_modtpl" rel="Chapter" href="Netcgi_modtpl.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Http_client_conncache" rel="Chapter" href="Http_client_conncache.html">
<link title="Http_client" rel="Chapter" href="Http_client.html">
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
<link title="Http_fs" rel="Chapter" href="Http_fs.html">
<link title="Ftp_fs" rel="Chapter" href="Ftp_fs.html">
<link title="Netclient_tut" rel="Chapter" href="Netclient_tut.html">
<link title="Netgssapi" rel="Chapter" href="Netgssapi.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_util" rel="Chapter" href="Nethttpd_util.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netmech_scram" rel="Chapter" href="Netmech_scram.html">
<link title="Netmech_scram_gssapi" rel="Chapter" href="Netmech_scram_gssapi.html">
<link title="Netmcore" rel="Chapter" href="Netmcore.html">
<link title="Netmcore_camlbox" rel="Chapter" href="Netmcore_camlbox.html">
<link title="Netmcore_mempool" rel="Chapter" href="Netmcore_mempool.html">
<link title="Netmcore_heap" rel="Chapter" href="Netmcore_heap.html">
<link title="Netmcore_ref" rel="Chapter" href="Netmcore_ref.html">
<link title="Netmcore_array" rel="Chapter" href="Netmcore_array.html">
<link title="Netmcore_sem" rel="Chapter" href="Netmcore_sem.html">
<link title="Netmcore_mutex" rel="Chapter" href="Netmcore_mutex.html">
<link title="Netmcore_condition" rel="Chapter" href="Netmcore_condition.html">
<link title="Netmcore_queue" rel="Chapter" href="Netmcore_queue.html">
<link title="Netmcore_buffer" rel="Chapter" href="Netmcore_buffer.html">
<link title="Netmcore_matrix" rel="Chapter" href="Netmcore_matrix.html">
<link title="Netmcore_hashtbl" rel="Chapter" href="Netmcore_hashtbl.html">
<link title="Netmcore_process" rel="Chapter" href="Netmcore_process.html">
<link title="Netmcore_tut" rel="Chapter" href="Netmcore_tut.html">
<link title="Netmcore_basics" rel="Chapter" href="Netmcore_basics.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_semaphore" rel="Chapter" href="Netplex_semaphore.html">
<link title="Netplex_sharedvar" rel="Chapter" href="Netplex_sharedvar.html">
<link title="Netplex_mutex" rel="Chapter" href="Netplex_mutex.html">
<link title="Netplex_encap" rel="Chapter" href="Netplex_encap.html">
<link title="Netplex_mbox" rel="Chapter" href="Netplex_mbox.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netplex_advanced" rel="Chapter" href="Netplex_advanced.html">
<link title="Netplex_admin" rel="Chapter" href="Netplex_admin.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netpagebuffer" rel="Chapter" href="Netpagebuffer.html">
<link title="Netfs" rel="Chapter" href="Netfs.html">
<link title="Netglob" rel="Chapter" href="Netglob.html">
<link title="Netauth" rel="Chapter" href="Netauth.html">
<link title="Netsockaddr" rel="Chapter" href="Netsockaddr.html">
<link title="Netnumber" rel="Chapter" href="Netnumber.html">
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
<link title="Xdr_mstring" rel="Chapter" href="Xdr_mstring.html">
<link title="Xdr" rel="Chapter" href="Xdr.html">
<link title="Netcompression" rel="Chapter" href="Netcompression.html">
<link title="Netunichar" rel="Chapter" href="Netunichar.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netsys_posix" rel="Chapter" href="Netsys_posix.html">
<link title="Netsys_pollset" rel="Chapter" href="Netsys_pollset.html">
<link title="Netlog" rel="Chapter" href="Netlog.html">
<link title="Netexn" rel="Chapter" href="Netexn.html">
<link title="Netsys_win32" rel="Chapter" href="Netsys_win32.html">
<link title="Netsys_pollset_posix" rel="Chapter" href="Netsys_pollset_posix.html">
<link title="Netsys_pollset_win32" rel="Chapter" href="Netsys_pollset_win32.html">
<link title="Netsys_pollset_generic" rel="Chapter" href="Netsys_pollset_generic.html">
<link title="Netsys_signal" rel="Chapter" href="Netsys_signal.html">
<link title="Netsys_oothr" rel="Chapter" href="Netsys_oothr.html">
<link title="Netsys_xdr" rel="Chapter" href="Netsys_xdr.html">
<link title="Netsys_rng" rel="Chapter" href="Netsys_rng.html">
<link title="Netsys_types" rel="Chapter" href="Netsys_types.html">
<link title="Netsys_mem" rel="Chapter" href="Netsys_mem.html">
<link title="Netsys_tmp" rel="Chapter" href="Netsys_tmp.html">
<link title="Netsys_sem" rel="Chapter" href="Netsys_sem.html">
<link title="Netsys_pmanage" rel="Chapter" href="Netsys_pmanage.html">
<link title="Netgzip" rel="Chapter" href="Netgzip.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_util" rel="Chapter" href="Rpc_util.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_auth_gssapi" rel="Chapter" href="Rpc_auth_gssapi.html">
<link title="Rpc_proxy" rel="Chapter" href="Rpc_proxy.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_intro_gss" rel="Chapter" href="Rpc_intro_gss.html">
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_fs" rel="Chapter" href="Shell_fs.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html">
<link title="Intro" rel="Chapter" href="Intro.html">
<link title="Platform" rel="Chapter" href="Platform.html">
<link title="Foreword" rel="Chapter" href="Foreword.html">
<link title="Ipv6" rel="Chapter" href="Ipv6.html">
<link title="Regexp" rel="Chapter" href="Regexp.html"><title>Ocamlnet 3 Reference Manual</title>
</head>
<body>
<h1>Ocamlnet 3 Reference Manual</h1>
Ocamlnet is an enhanced system platform library for Ocaml. As the name
suggests, large parts of it have to do with network programming, but
it is actually not restricted to this. Other parts deal with the
management of multiple worker processes, and the interaction with
other programs running on the same machine. You can also view Ocamlnet
as an extension of the system interface as provided by the <code class="code">Unix</code>
module of the standard library.
<p>
So, which kind of applications can profit from Ocamlnet?
<p>
<ul>
<li><b>Web applications</b> can use the <code class="code">netcgi2</code> library which provides
all core functionality like connecting to web servers, decomposing
web requests, and emitting web data. With the <code class="code">nethttpd</code> library
Ocamlnet even includes a little web server of its own, so
stand-alone Ocaml programs can respond to HTTP requests. This is
especially interesting for providing high-speed HTTP-based APIs
like REST interfaces.</li>
<li><b>Client/server architectures</b> can be built with the included SunRPC
support. This is a very robust and mature implementation of this
binary RPC protocol, both on the client and the server side. It
is wire-compatible with C implementations of SunRPC. There is a
generator for transforming SunRPC IDL files into Ocaml
modules. Authentication and encryption are also supported (using
GSS-API, or the non-standard SSL extension).</li>
<li><b>Compute jobs</b> profit from Ocamlnet because the <code class="code">netmulticore</code>
library allows it to run compute tasks on as many cores of the
machine as needed. The tasks can communicate with message passing
and exchange data via shared memory. Of course, <code class="code">netmulticore</code> is
strictly typed.</li>
<li><b>Any kind of application</b> can cherry-pick the parts of Ocamlnet
that are considered useful. Especially, Ocamlnet includes a number
of network clients (for HTTP, FTP, Telnet, SMTP, POP), and a large
number of network-related string processing functions (e.g. for
URL's, Base64, UTF-8, mail headers). For interacting with the system
there are functions to invoke subcommands (<code class="code">shell</code> library),
and also for globbing, sending email, and logging. Local and remote
filesystems can be accessed with the <a href="Netfs.html"><code class="code">Netfs</code></a> framework. The
<code class="code">netsys</code> library wraps lots of additional system calls that are
missing in the Ocaml standard library.</li>
</ul>
A number of ideas and concepts are used throughout the libraries:
<p>
<ul>
<li><a href="Netchannels.html"><code class="code">Netchannels</code></a> are a way to abstract sequential I/O channels</li>
<li>The event queues provided by <a href="Equeue.html"><code class="code">Equeue</code></a> and <a href="Unixqueue.html"><code class="code">Unixqueue</code></a> make
asynchronous protocol interpreters possible</li>
<li>The <code class="code">netplex</code> library manages worker subprocesses, e.g. for
accepting network connections or for doing computations.</li>
</ul>
<h2 id="2_Introductorychapters">Introductory chapters</h2>
<div class="guide">
<h3 id="3_Guides">Guides</h3>
<p>
<ul>
<li><a href="Foreword.html"><code class="code">Foreword</code></a>: How Ocamlnet is organized</li>
<li><a href="Platform.html"><code class="code">Platform</code></a>: Which functions are available on which platform
(POSIX/Win32). Also hints for portable programming.</li>
<li><a href="Ipv6.html"><code class="code">Ipv6</code></a>: The state of IPv6 support</li>
<li><a href="Regexp.html"><code class="code">Regexp</code></a>: Regular expression backends</li>
</ul>
</div>
<p>
Related external articles:
<p>
<ul>
<li><a href="http://blog.camlcity.org/blog/ocamlnet3_release.html"> Ocamlnet 3
finally released</a></li>
<li><a href="http://blog.camlcity.org/blog/ocamlnet3_win32.html"> Stranger in
a strange land</a>, by Gerd Stolpmann. The Win32 port in Ocamlnet 3.</li>
</ul>
<h2 id="2_Contentsbylibrary">Contents by library</h2>
<p>
<ul>
<li><a href="Intro.html#ch_base"><i>Base Libraries</i></a>
<ul>
<li><a href="Intro.html#netstring"><i>The netstring library: string processing functions</i></a></li>
<li><a href="Intro.html#netzip"><i>The netzip library: compression for object channels</i></a></li>
<li><a href="Intro.html#equeue"><i>The equeue library: concurrent execution flows via event queues</i></a></li>
<li><a href="Intro.html#netplex"><i>The netplex library: generic server framework</i></a></li>
<li><a href="Intro.html#netshm"><i>The netshm library: manage shared memory</i></a></li>
<li><a href="Intro.html#netsys"><i>The netsys library: system interfaces</i></a></li>
</ul>
</li>
<li><a href="Intro.html#ch_web"><i>Web Programming</i></a>
<ul>
<li><a href="Intro.html#netcgi2"><i>The netcgi2 library: web application framework</i></a></li>
<li><a href="Intro.html#netcgi2_apache"><i>The netcgi2-apache library: run web apps inside Apache</i></a></li>
<li><a href="Intro.html#netcgi2_plex"><i>The netcgi2-plex library: run web apps with Netplex</i></a></li>
<li><a href="Intro.html#nethttpd"><i>The nethttpd library: standalone web apps</i></a></li>
</ul>
</li>
<li><a href="Intro.html#ch_cs"><i>Client/Server Programming</i></a>
<ul>
<li><a href="Intro.html#rpc"><i>The rpc library: SunRPC</i></a></li>
<li><a href="Intro.html#rpc_local"><i>The rpc-auth-local extension: authentication for local sockets</i></a></li>
<li><a href="Intro.html#rpc_authdh"><i>The rpc-auth-dh extension: Diffie-Hellman authentication</i></a></li>
<li><a href="Intro.html#rpc_xti"><i>The rpc-xti extension: System V helpers</i></a></li>
<li><a href="Intro.html#rpc_ssl"><i>The rpc_ssl extension: SSL encryption</i></a></li>
<li><a href="Intro.html#netgssapi"><i>The netgssapi library with the GSS-API framework</i></a></li>
<li><a href="Intro.html#netmech_scram"><i>The netmech-scram library for SCRAM</i></a></li>
</ul>
</li>
<li><a href="Intro.html#ch_comp"><i>Parallel Computing</i></a>
<ul>
<li><a href="Intro.html#netcamlbox"><i>The netcamlbox library: message passing</i></a></li>
<li><a href="Intro.html#netmulticore"><i>The netmulticore library: compute jobs</i></a></li>
</ul>
</li>
<li><a href="Intro.html#ch_netproto"><i>Network Protocol Libraries</i></a>
<ul>
<li><a href="Intro.html#netclient"><i>The netclient library: HTTP, FTP, Telnet</i></a></li>
<li><a href="Intro.html#pop"><i>The pop library: POP protocol</i></a></li>
<li><a href="Intro.html#smtp"><i>The smtp library: SMTP protocol</i></a></li>
</ul>
</li>
</ul>
<p>
<h1 id="ch_base">Base Libraries</h1>
<p>
<div class="guide">
<h3 id="ch_base_guides">Guides</h3>
<p>
<ul>
<li><a href="Netchannels_tut.html"><code class="code">Netchannels_tut</code></a>: The <code class="code">Netchannels</code> tutorial - <b>strongly
recommended read!</b></li>
<li><a href="Netmime_tut.html"><code class="code">Netmime_tut</code></a>: The <code class="code">Netmime</code> tutorial</li>
<li><a href="Netsendmail_tut.html"><code class="code">Netsendmail_tut</code></a>: The <code class="code">Netsendmail</code> tutorial</li>
<li><a href="Netulex_tut.html"><code class="code">Netulex_tut</code></a>: The <code class="code">Netulex</code> tutorial</li>
<li><a href="Neturl_tut.html"><code class="code">Neturl_tut</code></a>: The <code class="code">Neturl</code> tutorial</li>
<li><a href="Equeue_howto.html"><code class="code">Equeue_howto</code></a>: The Equeue, Unixqueue, and Engines HOWTO</li>
<li><a href="Equeue_intro.html"><code class="code">Equeue_intro</code></a>: Introduction to programming with <code class="code">equeue</code></li>
<li><a href="Netplex_intro.html"><code class="code">Netplex_intro</code></a>: Introduction to <code class="code">Netplex</code></li>
<li><a href="Netplex_advanced.html"><code class="code">Netplex_advanced</code></a>: Advanced features of <code class="code">Netplex</code></li>
<li><a href="Netplex_admin.html"><code class="code">Netplex_admin</code></a>: Netplex administration guide</li>
<li><a href="Netshm_intro.html"><code class="code">Netshm_intro</code></a>: Shared Memory for IPC</li>
<li><a href="Shell_intro.html"><code class="code">Shell_intro</code></a>: Motivation for <code class="code">shell</code></li>
</ul>
</div>
<p>
<h3 id="equeue_blog">External articles</h3>
<p>
<ul>
<li><a href="http://ambassadortothecomputers.blogspot.com/2009/02/equeue-compared-to-lwt.html"> Equeue compared to Lwt</a>, by Jake Donham.</li>
<li><a href="http://blog.camlcity.org/blog/parallelmm.html"> Parallelizing with
Ocamlnet</a>, by Gerd Stolpmann. Demonstrates how to parallelize
matrix multiplications with Netplex-controlled worker processes.</li>
<li><a href="http://blog.camlcity.org/blog/ocamlnet3_mp.html">
Mastering Multi-processing</a>, by Gerd Stolpmann. About the new
synchronization primitives in Ocamlnet 3</li>
</ul>
<h2 id="netstring">The <code class="code">netstring</code> library: string processing functions</h2>
<p>
<code class="code">netstring</code> focuses on string processing functions, and base definitions
for other libraries.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netconversion.html">Netconversion</a></td><td><div class="info">
Conversion between character encodings
</div>
</td></tr>
<tr><td class="module"><a href="Netunichar.html">Netunichar</a></td><td><div class="info">
Unicode character information
</div>
</td></tr>
<tr><td class="module"><a href="Netchannels.html">Netchannels</a></td><td><div class="info">
Object-oriented I/O: Basic types and classes
</div>
</td></tr>
<tr><td class="module"><a href="Netstream.html">Netstream</a></td><td><div class="info">
A netstream is an input channel that is read block by block.
</div>
</td></tr>
<tr><td class="module"><a href="Mimestring.html">Mimestring</a></td><td><div class="info">
Low-level functions to parse and print mail and MIME messages
</div>
</td></tr>
<tr><td class="module"><a href="Netmime.html">Netmime</a></td><td><div class="info">
Netmime contains high-level classes and functions to process
mail and MIME messages.
</div>
</td></tr>
<tr><td class="module"><a href="Netsendmail.html">Netsendmail</a></td><td><div class="info">
Functions to compose and send electronic mails
</div>
</td></tr>
<tr><td class="module"><a href="Neturl.html">Neturl</a></td><td><div class="info">
Uniform Resource Locators (URLs)
</div>
</td></tr>
<tr><td class="module"><a href="Netsockaddr.html">Netsockaddr</a></td><td><div class="info">
Parsing of socket addresses
</div>
</td></tr>
<tr><td class="module"><a href="Netaddress.html">Netaddress</a></td><td><div class="info">
Parsing of mail addresses
</div>
</td></tr>
<tr><td class="module"><a href="Netbuffer.html">Netbuffer</a></td><td><div class="info">
A Netbuffer.t is a buffer that can grow and shrink dynamically.
</div>
</td></tr>
<tr><td class="module"><a href="Netpagebuffer.html">Netpagebuffer</a></td><td><div class="info">
Buffer for page-aligned I/O
</div>
</td></tr>
<tr><td class="module"><a href="Netdate.html">Netdate</a></td><td><div class="info">
Support for common date/time parsing and formatting.
</div>
</td></tr>
<tr><td class="module"><a href="Netencoding.html">Netencoding</a></td><td><div class="info">
Base64, Quoted Printable, URL encoding, HTML escaping
</div>
</td></tr>
<tr><td class="module"><a href="Netulex.html">Netulex</a></td><td><div class="info">
Support module for Alain Frisch's <code class="code">ulex</code> lexer generator
</div>
</td></tr>
<tr><td class="module"><a href="Netaccel.html">Netaccel</a></td><td><div class="info">
Accelerators for bytecode
</div>
</td></tr>
<tr><td class="module"><a href="Netaccel_link.html">Netaccel_link</a></td><td><div class="info">
Enables accelerator module <code class="code">Netaccel</code>
</div>
</td></tr>
<tr><td class="module"><a href="Nethtml.html">Nethtml</a></td><td><div class="info">
Parsing of HTML
</div>
</td></tr>
<tr><td class="module"><a href="Nethttp.html">Nethttp</a></td><td><div class="info">
Basic definitions for the HTTP protocol
</div>
</td></tr>
<tr><td class="module"><a href="Netfs.html">Netfs</a></td><td><div class="info">
Class type <code class="code">stream_fs</code> for filesystems with stream access to files
</div>
</td></tr>
<tr><td class="module"><a href="Netglob.html">Netglob</a></td><td><div class="info">
Globbing
</div>
</td></tr>
<tr><td class="module"><a href="Netauth.html">Netauth</a></td><td><div class="info">
Some primitives for authentication
</div>
</td></tr>
<tr><td class="module"><a href="Netcompression.html">Netcompression</a></td><td><div class="info">
Registry for compression algorithms
</div>
</td></tr>
<tr><td class="module"><a href="Netstring_str.html">Netstring_str</a></td><td><div class="info">
Wrapper for regexps with <code class="code">Str</code> syntax
</div>
</td></tr>
<tr><td class="module"><a href="Netmappings.html">Netmappings</a></td><td><div class="info">
Internal access to the character conversion database
</div>
</td></tr>
<tr><td class="module"><a href="Netaux.html">Netaux</a></td><td><div class="info">
Internal auxiliary functions
</div>
</td></tr>
<tr><td class="module"><a href="Netnumber.html">Netnumber</a></td><td><div class="info">
Binary encodings of numbers
</div>
</td></tr>
<tr><td class="module"><a href="Rtypes.html">Rtypes</a></td><td><div class="info">
Binary encodings of numbers (Legacy)
</div>
</td></tr>
<tr><td class="module"><a href="Xdr.html">Xdr</a></td><td><div class="info">
External Data Representation
</div>
</td></tr>
<tr><td class="module"><a href="Xdr_mstring.html">Xdr_mstring</a></td><td><div class="info">
Managed Strings
</div>
</td></tr>
</table>
<p>
<h2 id="netstring_pcre">The <code class="code">netstring-pcre</code> library: additions for PCRE</h2>
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netstring_pcre.html">Netstring_pcre</a></td><td><div class="info">
Wrapper for regexps with PCRE syntax
</div>
</td></tr>
</table>
<p>
<h2 id="netzip">The <code class="code">netzip</code> library: compression for object channels</h2>
<p>
Support for (un)compressing data on the fly with object channels.
Requires ocamlzip.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netgzip.html">Netgzip</a></td><td><div class="info">
Gzip object channels
</div>
</td></tr>
</table>
<p>
<h2 id="equeue">The <code class="code">equeue</code> library: concurrent execution flows via event queues</h2>
<p>
<code class="code">equeue</code> is a fundamental library for event queues. It is mainly used
by a number of other libraries of Ocamlnet to parallelize network code
(so-called multiplexing).
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Equeue.html">Equeue</a></td><td><div class="info">
<code class="code">Equeue</code> implements generic event queues.
</div>
</td></tr>
<tr><td class="module"><a href="Unixqueue.html">Unixqueue</a></td><td><div class="info">
Unixqueues are one of the two forms of system event loops provided
by Ocamlnet.
</div>
</td></tr>
<tr><td class="module"><a href="Unixqueue_pollset.html">Unixqueue_pollset</a></td><td><div class="info">
Unixqueue implementation on top of <a href="Netsys_pollset.html"><code class="code">Netsys_pollset</code></a>
</div>
</td></tr>
<tr><td class="module"><a href="Unixqueue_select.html">Unixqueue_select</a></td><td><div class="info">
This the old <code class="code">Unix.select</code>-based imeplementation of event systems
which was the default one until Ocamlnet-2.2.
</div>
</td></tr>
<tr><td class="module"><a href="Uq_engines.html">Uq_engines</a></td><td><div class="info">
An <b>engine</b> performs a certain task in an autonomous way.
</div>
</td></tr>
<tr><td class="module"><a href="Uq_socks5.html">Uq_socks5</a></td><td><div class="info">
This module implements a SOCKS version 5 client (see RFC 1928) for
use with the <a href="Uq_engines.html#VALconnector"><code class="code">Uq_engines.connector</code></a>, <a href="Uq_engines.html#VALlistener"><code class="code">Uq_engines.listener</code></a>, and
<a href="Uq_engines.html#VALdatagram_provider"><code class="code">Uq_engines.datagram_provider</code></a> engine factories.
</div>
</td></tr>
<tr><td class="module"><a href="Uq_resolver.html">Uq_resolver</a></td><td><div class="info">
Support for pluggable resolvers
</div>
</td></tr>
<tr><td class="module"><a href="Uq_io.html">Uq_io</a></td><td><div class="info">
Unified engines for stream I/O
</div>
</td></tr>
<tr><td class="module"><a href="Uq_lwt.html">Uq_lwt</a></td><td><div class="info">
Compatibility with <code class="code">Lwt</code>
</div>
</td></tr>
<tr><td class="module"><a href="Uq_libevent.html">Uq_libevent</a></td><td><div class="info">
Use Libevent as event loop
</div>
</td></tr>
<tr><td class="module"><a href="Uq_mt.html">Uq_mt</a></td><td><div class="info">
Using engines in multi-threaded programs
</div>
</td></tr>
</table>
<p>
<h3 id="equeue_gtk">The <code class="code">equeue-gtk1</code> and <code class="code">equeue-gtk2</code> extensions</h3>
<p>
Extensions for <code class="code">equeue</code> to integrate the event queue into user interfaces
made with lablgtk and lablgtk2
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Uq_gtk.html">Uq_gtk</a></td><td><div class="info">
Integration with lablgtk/lablgtk2 event systems
</div>
</td></tr>
</table>
<p>
<h3 id="equeue_ssl">The <code class="code">equeue-ssl</code> extension</h3>
<p>
Extensions for <code class="code">equeue</code> to support SSL
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Uq_ssl.html">Uq_ssl</a></td><td><div class="info">
Asynchronous SSL connections
</div>
</td></tr>
<tr><td class="module"><a href="Https_client.html">Https_client</a></td><td><div class="info">
HTTPS extension to <a href="Http_client.html"><code class="code">Http_client</code></a>
</div>
</td></tr>
</table>
<p>
<h3 id="equeue_tcl">The <code class="code">equeue-tcl</code> extension</h3>
<p>
Extension for <code class="code">equeue</code> to integrate the event queue into user interfaces
made with labltk
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Uq_tcl.html">Uq_tcl</a></td><td><div class="info">
Integration with the labltk event system
</div>
</td></tr>
</table>
<p>
<h2 id="netplex">The <code class="code">netplex</code> library: generic server framework</h2>
<p>
The <code class="code">netplex</code> library is a protocol-independent server framework.
Especially, it can be used in conjunction with <code class="code">nethttpd</code> to
build web servers, and with <code class="code">rpc</code> to build RPC servers.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netplex_types.html">Netplex_types</a></td><td><div class="info">
Types for <code class="code">Netplex</code>
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_config.html">Netplex_config</a></td><td><div class="info">
Read the configuration file
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_controller.html">Netplex_controller</a></td><td><div class="info">
Controller
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_container.html">Netplex_container</a></td><td><div class="info">
Containers
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_sockserv.html">Netplex_sockserv</a></td><td><div class="info">
Socket service creation
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_workload.html">Netplex_workload</a></td><td><div class="info">
Workload management
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_kit.html">Netplex_kit</a></td><td><div class="info">
Netplex toolkit
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_cenv.html">Netplex_cenv</a></td><td><div class="info">
Container environment
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_log.html">Netplex_log</a></td><td><div class="info">
Loggers
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_main.html">Netplex_main</a></td><td><div class="info">
Main program for Netplex servers
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_mp.html">Netplex_mp</a></td><td><div class="info">
Multi-processing provider
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_mt.html">Netplex_mt</a></td><td><div class="info">
Multi-threading provider
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_mutex.html">Netplex_mutex</a></td><td><div class="info">
Netplex-wide mutexes
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_semaphore.html">Netplex_semaphore</a></td><td><div class="info">
Netplex-wide semaphores
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_sharedvar.html">Netplex_sharedvar</a></td><td><div class="info">
Netplex-wide variables
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_mbox.html">Netplex_mbox</a></td><td><div class="info">
Netplex message boxes
</div>
</td></tr>
<tr><td class="module"><a href="Netplex_encap.html">Netplex_encap</a></td><td><div class="info">
Type-safe marshalling between processes of the same executable
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_netplex.html">Rpc_netplex</a></td><td><div class="info">
Netplex support for RPC servers (TCP only)
</div>
</td></tr>
</table>
<p>
<h2 id="shell">The <code class="code">shell</code> library: start external commands</h2>
<p>
The <code class="code">shell</code> library allows you to start external commands. It is integrated
into <code class="code">equeue</code>.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Shell.html">Shell</a></td><td><div class="info">
Calls external programs, creates pipelines, etc.
</div>
</td></tr>
<tr><td class="module"><a href="Shell_sys.html">Shell_sys</a></td><td><div class="info">
Calls external programs, creates pipelines, etc.
</div>
</td></tr>
<tr><td class="module"><a href="Shell_uq.html">Shell_uq</a></td><td><div class="info">
Run shell commands within Unixqueues
</div>
</td></tr>
<tr><td class="module"><a href="Shell_fs.html">Shell_fs</a></td><td><div class="info">
Shell filesystem
</div>
</td></tr>
</table>
<p>
<h2 id="netshm">The <code class="code">netshm</code> library: manage shared memory</h2>
<p>
The <code class="code">netshm</code> library manages a shared memory object either as hash table
or array. It is designed to be used in multi-processing program architectures.
Note that there is now also the much better <a href="Intro.html#netmulticore"><i>The netmulticore library: compute jobs</i></a> library.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netshm.html">Netshm</a></td><td><div class="info">
Shared memory for O'Caml programs using multi-processing
</div>
</td></tr>
<tr><td class="module"><a href="Netshm_data.html">Netshm_data</a></td><td><div class="info">
Data representation for shared memory
</div>
</td></tr>
<tr><td class="module"><a href="Netshm_hashtbl.html">Netshm_hashtbl</a></td><td><div class="info">
Hash tables in shared memory
</div>
</td></tr>
<tr><td class="module"><a href="Netshm_array.html">Netshm_array</a></td><td><div class="info">
Arrays in shared memory
</div>
</td></tr>
</table>
<p>
<h2 id="netsys">The <code class="code">netsys</code> library: system interfaces</h2>
<p>
The <code class="code">netsys</code> library contains a number of low-level functions used by
other Ocamlnet libraries.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Platform.html">Platform</a></td><td></td></tr>
<tr><td class="module"><a href="Netexn.html">Netexn</a></td><td><div class="info">
Exception registry
</div>
</td></tr>
<tr><td class="module"><a href="Netlog.html">Netlog</a></td><td><div class="info">
Basic logging facility
</div>
</td></tr>
<tr><td class="module"><a href="Netsys.html">Netsys</a></td><td><div class="info">
System calls missing in the <code class="code">Unix</code> module
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_posix.html">Netsys_posix</a></td><td><div class="info">
POSIX-specific system calls missing in the <code class="code">Unix</code> module, and
further API's from POSIX-style operating systems.
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_oothr.html">Netsys_oothr</a></td><td><div class="info">
Object-oriented thread API
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_signal.html">Netsys_signal</a></td><td><div class="info">
Signal handler framework
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_tmp.html">Netsys_tmp</a></td><td><div class="info">
Temporary files
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_mem.html">Netsys_mem</a></td><td><div class="info">
Bigarrays as memory buffers
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_sem.html">Netsys_sem</a></td><td><div class="info">
Generic anonymous semaphores
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_pollset.html">Netsys_pollset</a></td><td><div class="info">
Sets of file descriptors for polling
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_pollset_generic.html">Netsys_pollset_generic</a></td><td><div class="info">
Returns a good standard implementation of pollset for this platform.
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_pollset_posix.html">Netsys_pollset_posix</a></td><td><div class="info">
Pollsets for POSIX operating systems
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_pollset_win32.html">Netsys_pollset_win32</a></td><td><div class="info">
Pollsets for Win32
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_win32.html">Netsys_win32</a></td><td><div class="info">
Primitives for Win32
</div>
</td></tr>
<tr><td class="module"><a href="Netsys_rng.html">Netsys_rng</a></td><td><div class="info">
Random-number generator
</div>
</td></tr>
</table>
<p>
<h1 id="ch_web">Web Programming</h1>
<p>
<div class="guide">
<p>
<h3 id="ch_web_guides">Guides</h3>
<p>
<ul>
<li><a href="Netcgi_porting.html"><code class="code">Netcgi_porting</code></a>: Porting <code class="code">netcgi1</code> programs to <code class="code">netcgi2</code></li>
<li><a href="Nethttpd_intro.html"><code class="code">Nethttpd_intro</code></a>: Overview over the HTTP daemon</li>
</ul>
</div>
<p>
<h3 id="netcgi1">The <code class="code">netcgi1</code> library</h3>
<p>
The <code class="code">netcgi1</code> library is no longer supported in Ocamlnet 3. Please
switch to <code class="code">netcgi2</code>.
<p>
<h2 id="netcgi2">The <code class="code">netcgi2</code> library: web application framework</h2>
<p>
This is the revised library for Web applications, now called <code class="code">netcgi2</code>.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netcgi.html">Netcgi</a></td><td><div class="info">
Common data-structures for CGI-like connectors.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_common.html">Netcgi_common</a></td><td><div class="info">
Functions to develop new connectors.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_cgi.html">Netcgi_cgi</a></td><td><div class="info">
Classical CGI connector.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_fcgi.html">Netcgi_fcgi</a></td><td><div class="info">
FastCGI connector.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_ajp.html">Netcgi_ajp</a></td><td><div class="info">
Apache JServ Protocol (AJP) 1.3 connector.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_scgi.html">Netcgi_scgi</a></td><td><div class="info">
SCGI connector.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_test.html">Netcgi_test</a></td><td><div class="info">
Connector for testing your code.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_dbi.html">Netcgi_dbi</a></td><td><div class="info">
Pools of connections for the ocamldbi generic database interface.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi1_compat.html">Netcgi1_compat</a></td><td><div class="info">
<span class="deprecated">Compatibility module with the previous version of Netcgi.
</span></div>
</td></tr>
</table>
<p>
<h2 id="netcgi2_apache">The <code class="code">netcgi2-apache</code> library: run web apps inside Apache</h2>
<p>
This is an Apache connector for the <code class="code">netcgi2</code> library.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netcgi_apache.html">Netcgi_apache</a></td><td><div class="info">
Netcgi Apache "mod" connector.
</div>
</td></tr>
<tr><td class="module"><a href="Netcgi_modtpl.html">Netcgi_modtpl</a></td><td><div class="info">
<span class="deprecated"></span></div>
</td></tr>
</table>
<p>
<h2 id="netcgi2_plex">The <code class="code">netcgi2-plex</code> library: run web apps with Netplex</h2>
<p>
Netplex support for running Netcgi2 connectors:
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netcgi_plex.html">Netcgi_plex</a></td><td><div class="info">
Netplex support for FastCGI, SCGI and AJP connectors
</div>
</td></tr>
</table>
<p>
<h2 id="nethttpd">The <code class="code">nethttpd</code> library: standalone web apps</h2>
<p>
The <code class="code">nethttpd</code> library is a Web server component written in O'Caml.
For a full web server, you'll also need <code class="code">netplex</code>.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Nethttpd_types.html">Nethttpd_types</a></td><td><div class="info">
Type definitions for the HTTP daemon
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_kernel.html">Nethttpd_kernel</a></td><td><div class="info">
The protocol kernel of the HTTP daemon
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_reactor.html">Nethttpd_reactor</a></td><td><div class="info">
The reactive encapsulation of the HTTP daemon
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_engine.html">Nethttpd_engine</a></td><td><div class="info">
The event-based encapsulation of the HTTP daemon
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_services.html">Nethttpd_services</a></td><td><div class="info">
Service Providers for HTTP daemon
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_plex.html">Nethttpd_plex</a></td><td><div class="info">
Netplex support
</div>
</td></tr>
<tr><td class="module"><a href="Nethttpd_util.html">Nethttpd_util</a></td><td><div class="info">
Utility functions
</div>
</td></tr>
</table>
<p>
<h1 id="ch_cs">Client/Server Programming</h1>
<p>
<div class="guide">
<h3 id="ch_cs_guides">Guides</h3>
<p>
<ul>
<li><a href="Rpc_intro.html"><code class="code">Rpc_intro</code></a>: Introduction</li>
<li><a href="Rpc_mapping_ref.html"><code class="code">Rpc_mapping_ref</code></a>: RPC Language Mapping Reference</li>
<li><a href="Rpc_intro_gss.html"><code class="code">Rpc_intro_gss</code></a>: Securing RPC with the GSS-API</li>
</ul>
</div>
<p>
<h3 id="ch_cs_blog">External articles</h3>
<p>
<ul>
<li><a href="http://blog.camlcity.org/blog/ocamlnet3_ha.html"> The next server,
please!</a>, by Gerd Stolpmann. About highly-available RPC.</li>
</ul>
<h2 id="rpc">The <code class="code">rpc</code> library: SunRPC</h2>
<p>
This library implements OncRPC (alias SunRPC).
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Rpc.html">Rpc</a></td><td><div class="info">
Common types and exceptions
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_program.html">Rpc_program</a></td><td><div class="info">
RPC programs
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_client.html">Rpc_client</a></td><td><div class="info">
RPC clients
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_simple_client.html">Rpc_simple_client</a></td><td><div class="info">
Synchronous API for RPC clients
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_proxy.html">Rpc_proxy</a></td><td><div class="info">
RPC proxies
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_server.html">Rpc_server</a></td><td><div class="info">
RPC servers
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_auth_sys.html">Rpc_auth_sys</a></td><td><div class="info">
Authentication module AUTH_SYS
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_portmapper.html">Rpc_portmapper</a></td><td><div class="info">
Portmapper version 2
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_portmapper_aux.html">Rpc_portmapper_aux</a></td><td></td></tr>
<tr><td class="module"><a href="Rpc_portmapper_clnt.html">Rpc_portmapper_clnt</a></td><td></td></tr>
<tr><td class="module"><a href="Rpc_transport.html">Rpc_transport</a></td><td><div class="info">
Low-level RPC transporters
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_packer.html">Rpc_packer</a></td><td><div class="info">
The first n bytes of the packed value
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_auth_gssapi.html">Rpc_auth_gssapi</a></td><td><div class="info">
GSS-API for RPC authentication
</div>
</td></tr>
</table>
<p>
<h2 id="rpc_local">The <code class="code">rpc-auth-local</code> extension: authentication for local sockets</h2>
<p>
Authentication for local socket connections.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Rpc_auth_local.html">Rpc_auth_local</a></td><td><div class="info">
Return the authentication method <code class="code">AUTH_LOCAL</code>.
</div>
</td></tr>
</table>
<p>
<h2 id="rpc_authdh">The <code class="code">rpc-auth-dh</code> extension: Diffie-Hellman authentication</h2>
<p>
This is Diffie-Hellman authentication for OncRPC (also known as
"Secure RPC").
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Rpc_auth_dh.html">Rpc_auth_dh</a></td><td><div class="info">
Diffie-Hellman authentication (AUTH_DH alias AUTH_DES)
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_key_service.html">Rpc_key_service</a></td><td><div class="info">
Contact the keyserv daemon to encrypt/decrypt data with the common
key.
</div>
</td></tr>
<tr><td class="module"><a href="Rpc_time.html">Rpc_time</a></td><td><div class="info">
Get the time of the server (using the RFC 868 netdate protocol)
</div>
</td></tr>
</table>
<p>
<h2 id="rpc_xti">The <code class="code">rpc-xti</code> extension: System V helpers</h2>
<p>
System V provides a network API called XTI in addition to the socket API.
This library allows it to connect to RPC services that can only be reached
over a local XTI connection ("cots" connection).
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Rpc_xti_client.html">Rpc_xti_client</a></td><td><div class="info">
Minimal support for TI-RPC over the XTI API
</div>
</td></tr>
</table>
<p>
<h2 id="rpc_ssl">The <code class="code">rpc_ssl</code> extension: SSL encryption</h2>
<p>
This library allows you to tunnel RPC through SSL/TLS.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Rpc_ssl.html">Rpc_ssl</a></td><td><div class="info">
Securing RPC by SSL
</div>
</td></tr>
</table>
<p>
<h2 id="netgssapi">The <code class="code">netgssapi</code> library with the GSS-API framework</h2>
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netgssapi.html">Netgssapi</a></td><td><div class="info">
GSS-API Definition
</div>
</td></tr>
</table>
<p>
<h2 id="netmech_scram">The <code class="code">netmech-scram</code> library for SCRAM</h2>
<p>
Implements SCRAM (RFC 5802). Right now only for GSS-API.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netmech_scram.html">Netmech_scram</a></td><td><div class="info">
SCRAM mechanism for authentication (RFC 5802)
</div>
</td></tr>
<tr><td class="module"><a href="Netmech_scram_gssapi.html">Netmech_scram_gssapi</a></td><td><div class="info">
The SCRAM security mechanism for GSS-API
</div>
</td></tr>
</table>
<p>
<h1 id="ch_comp">Parallel Computing</h1>
<p>
<div class="guide">
<h3 id="netmcore_intro">Guides</h3>
<p>
<ul>
<li><a href="Netmcore_basics.html"><code class="code">Netmcore_basics</code></a>: Basics</li>
<li><a href="Netmcore_tut.html"><code class="code">Netmcore_tut</code></a>: Tutorial</li>
</ul>
</div>
<p>
<b>Important change since OCaml-4.01:</b> This OCaml version changed the
semantics of the built-in primitives <code class="code">caml_modify</code> and
<code class="code">caml_initialize</code>. Essentially, it is no longer possible to modify
OCaml values residing outside the regular OCaml heap. As we do this
inside Netcamlbox and Netmulticore, this change affects these
libraries. Fortunately, there is a workaround on systems supporting weak
symbols (all ELF systems and OS X): Here, <code class="code">caml_modify</code> and
<code class="code">caml_initialize</code> are overridden by Ocamlnet so that they are
again compatible. Note that this is a global modification of the
runtime system!
<p>
<h2 id="netcamlbox">The <code class="code">netcamlbox</code> library: message passing</h2>
<p>
Camlbox is a fast message-passing system between processes running on
the same machine. It uses shared memory for communication. A message
sent to a Camlbox is only copied once, not twice.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netcamlbox.html">Netcamlbox</a></td><td><div class="info">
Camlboxes are a fast IPC mechanism to send Ocaml values from one
process to another.
</div>
</td></tr>
</table>
<p>
<h2 id="netmulticore">The <code class="code">netmulticore</code> library: compute jobs</h2>
<p>
Netmulticore is an experimental framework for managing multiple
processes, and sending messages between them.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netmcore.html">Netmcore</a></td><td><div class="info">
Multi-processing for compute jobs
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_process.html">Netmcore_process</a></td><td><div class="info">
Statically typed processes
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_mempool.html">Netmcore_mempool</a></td><td><div class="info">
Memory pools
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_heap.html">Netmcore_heap</a></td><td><div class="info">
Shared heaps of structured values
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_array.html">Netmcore_array</a></td><td><div class="info">
Shared arrays
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_buffer.html">Netmcore_buffer</a></td><td><div class="info">
Shared buffer
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_hashtbl.html">Netmcore_hashtbl</a></td><td><div class="info">
Shared hashtables
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_matrix.html">Netmcore_matrix</a></td><td><div class="info">
Shared 2-dimensional arrays (matrices)
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_queue.html">Netmcore_queue</a></td><td><div class="info">
Shared queues
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_ref.html">Netmcore_ref</a></td><td><div class="info">
Shared mutable variables
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_mutex.html">Netmcore_mutex</a></td><td><div class="info">
Mutexes
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_sem.html">Netmcore_sem</a></td><td><div class="info">
Semaphores
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_condition.html">Netmcore_condition</a></td><td><div class="info">
Condition variables
</div>
</td></tr>
<tr><td class="module"><a href="Netmcore_camlbox.html">Netmcore_camlbox</a></td><td><div class="info">
Camlboxes for use in netmulticore programs
</div>
</td></tr>
</table>
<p>
<h1 id="ch_netproto">Network Protocol Libraries</h1>
<p>
<div class="guide">
<h3 id="ch_netproto_guides">Guides</h3>
<p>
<ul>
<li><a href="Netclient_tut.html"><code class="code">Netclient_tut</code></a>: The Netclient tutorial (HTTP, FTP)</li>
</ul>
</div>
<p>
<h2 id="netclient">The <code class="code">netclient</code> library: HTTP, FTP, Telnet</h2>
<p>
This library includes clients for HTTP, Telnet, and FTP.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Http_client.html">Http_client</a></td><td><div class="info">
HTTP 1.1 client
</div>
</td></tr>
<tr><td class="module"><a href="Http_client_conncache.html">Http_client_conncache</a></td><td><div class="info">
Connection cache
</div>
</td></tr>
<tr><td class="module"><a href="Http_fs.html">Http_fs</a></td><td><div class="info">
HTTP filesystem
</div>
</td></tr>
<tr><td class="module"><a href="Ftp_client.html">Ftp_client</a></td><td><div class="info">
FTP client
</div>
</td></tr>
<tr><td class="module"><a href="Ftp_data_endpoint.html">Ftp_data_endpoint</a></td><td><div class="info">
Senders and receivers for the FTP data connection
</div>
</td></tr>
<tr><td class="module"><a href="Ftp_fs.html">Ftp_fs</a></td><td><div class="info">
FTP filesystem
</div>
</td></tr>
<tr><td class="module"><a href="Telnet_client.html">Telnet_client</a></td><td><div class="info">
Telnet client
</div>
</td></tr>
</table>
<p>
<h2 id="pop">The <code class="code">pop</code> library: POP protocol</h2>
<p>
This is a simple POP 3 client.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netpop.html">Netpop</a></td><td><div class="info">
This is an interface for the Post Office Protocol - Version 3
(POP3) as specifed by RFC 1939.
</div>
</td></tr>
</table>
<p>
<h2 id="smtp">The <code class="code">smtp</code> library: SMTP protocol</h2>
<p>
This is a simple SMTP client.
<p>
<br>
<table class="indextable">
<tr><td class="module"><a href="Netsmtp.html">Netsmtp</a></td><td><div class="info">
This is an interface for the Simple Mail Tranfer Protocol (SMTP)
as specified by RFC 2821.
</div>
</td></tr>
</table>
<p>
<h1 id="1_Trailer">Trailer</h1>
<p>
<h2 id="2_Index">Index</h2>
<p>
<ul class="indexlist">
<li><a href="index_types.html">Index of types</a></li>
<li><a href="index_exceptions.html">Index of exceptions</a></li>
<li><a href="index_values.html">Index of values</a></li>
<li><a href="index_attributes.html">Index of class attributes</a></li>
<li><a href="index_methods.html">Index of class methods</a></li>
<li><a href="index_classes.html">Index of classes</a></li>
<li><a href="index_class_types.html">Index of class types</a></li>
<li><a href="index_modules.html">Index of modules</a></li>
<li><a href="index_module_types.html">Index of module types</a></li>
</ul>
<p>
<h2 id="2_Authors">Authors</h2>
<p>
The Ocamlnet libraries have been initially written by Gerd Stolpmann and
Patrick Doane.
<p>
Contributions by
<p>
<ul>
<li>Nicolas George: Netdate</li>
<li>Eric Stokes: FastCGI support</li>
<li>Pierre Habouzit: SMTP client</li>
<li>Christophe Troestler: Revised version of <code class="code">netcgi</code></li>
<li>Deokhwan Kim: Support for EUC-KR</li>
</ul>
Sponsorships by
<p>
<ul>
<li>Baretta s.r.l: Nethttpd</li>
<li>California State University: SSL support for RPC, Netplex</li>
</ul>
<br>
</body>
</html>
