<!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="Nethttpd_services.html"> <link rel="next" href="Nethttpd_intro.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="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="Uq_engines" rel="Chapter" href="Uq_engines.html"> <link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html"> <link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html"> <link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html"> <link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html"> <link title="Uq_tcl" rel="Chapter" href="Uq_tcl.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" 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="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_intro" rel="Chapter" href="Nethttpd_intro.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_intro" rel="Chapter" href="Netplex_intro.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="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html"> <link title="Netstring_mt" rel="Chapter" href="Netstring_mt.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="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="Netsys" rel="Chapter" href="Netsys.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="Rtypes" rel="Chapter" href="Rtypes.html"> <link title="Xdr" rel="Chapter" href="Xdr.html"> <link title="Rpc" rel="Chapter" href="Rpc.html"> <link title="Rpc_program" rel="Chapter" href="Rpc_program.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_intro" rel="Chapter" href="Rpc_intro.html"> <link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.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_mt" rel="Chapter" href="Shell_mt.html"> <link title="Shell_intro" rel="Chapter" href="Shell_intro.html"> <link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Nethttpd_plex</title> </head> <body> <div class="navbar"><a href="Nethttpd_services.html">Previous</a> <a href="index.html">Up</a> <a href="Nethttpd_intro.html">Next</a> </div> <center><h1>Module <a href="type_Nethttpd_plex.html">Nethttpd_plex</a></h1></center> <br> <pre><span class="keyword">module</span> Nethttpd_plex: <code class="code">sig</code> <a href="Nethttpd_plex.html">..</a> <code class="code">end</code></pre><a name="1_Netplexsupport"></a> <h1>Netplex support</h1><br> <hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEconfig_log_error"></a><code class="type"></code>config_log_error = <code class="type">Unix.sockaddr option -><br> Unix.sockaddr option -><br> <a href="Nethttp.html#TYPEhttp_method">Nethttp.http_method</a> option -> <a href="Nethttp.http_header.html">Nethttp.http_header</a> option -> string -> unit</code> </pre> <pre><span class="keyword">val</span> <a name="VALnethttpd_processor"></a>nethttpd_processor : <code class="type">(<a href="Nethttpd_plex.html#TYPEconfig_log_error">config_log_error</a> -> #<a href="Nethttpd_reactor.http_reactor_config.html">Nethttpd_reactor.http_reactor_config</a>) -><br> 'a <a href="Nethttpd_types.http_service.html">Nethttpd_types.http_service</a> -> <a href="Netplex_types.processor.html">Netplex_types.processor</a></code></pre><div class="info"> <code class="code">netplex_processor mk_config http_service</code>: Creates a Netplex processor for Nethttpd. <p> <code class="code">mk_config</code> gets a logging function as argument that will log to the Netplex logging service. This function has the same type as the <code class="code">config_log_error</code> method of the <code class="code">http_reactor_config</code>. <p> The resulting processor must be turned into a full Netplex service by <code class="code">Netplex_sockserv.create_socket_service</code> which can then be added by calling the controller's method <code class="code">add_service</code>.<br> </div> <pre><span class="keyword">val</span> <a name="VALnethttpd_factory"></a>nethttpd_factory : <code class="type">?config_cgi:<a href="Netcgi1_compat.Netcgi_env.html#TYPEcgi_config">Netcgi1_compat.Netcgi_env.cgi_config</a> -><br> ?handlers:(string *<br> #<a href="Netcgi1_compat.Netcgi_types.cgi_activation.html">Netcgi1_compat.Netcgi_types.cgi_activation</a><br> <a href="Nethttpd_services.html#TYPEdynamic_service">Nethttpd_services.dynamic_service</a>)<br> list -><br> unit -> <a href="Netplex_types.processor_factory.html">Netplex_types.processor_factory</a></code></pre><div class="info"> Reads a configuration section like <pre><code class="code"> processor { type = "nethttpd"; timeout = 300.0; timeout_next_request = 15.0; host { pref_name = "myhost"; (* optional *) pref_port = 80; (* optional *) names = "myhost:80 yourhost:81"; (* use *:0 for any name *) uri { path = "/the/path"; method { allow = "GET POST"; (* or: deny = "..." *) service { type = "..."; ... } } } uri { ... } } host { ... } } </code></pre> <p> The sections <code class="code">host</code>, <code class="code">uri</code> and <code class="code">method</code> can be nested to any depth. However, on every nesting level only one of these section types must be used. For example, if a <code class="code">host</code> section already contains <code class="code">uri</code> subsections, it is not allowed to add <code class="code">method</code> subsections. Furthermore, the outermost section must be <code class="code">host</code>. <p> The <code class="code">service</code> section may be one of: <p> <pre><code class="code"> service { type = "file"; docroot = "/a/path/in/the/filesystem"; uri = "/the/uri/prefix/corresponding/to/docroot"; media_types_file = "/etc/mime.types"; media_type { type = "application/foo"; suffix = "foo" } default_media_type = "text/plain"; enable_gzip = true; (* see doc in nethttpd_services.mli *) index_files = "index.html"; enable_listings = true; hide_from_listings = "README"; (* list of PCRE regexps *) } </code></pre> <p> Note that <code class="code">uri</code> is taken from the surrounding <code class="code">uri</code> section (or assumed to be "/" if there is none) if omitted. <p> <pre><code class="code"> service { type = "dynamic"; handler = "name_of_handler"; } </code></pre> <p> Binds the passed handler here. <p> Any of <code class="code">host</code>, <code class="code">uri</code>, and <code class="code">method</code> sections may contain one or several <code class="code">access</code> sections (which are AND-connected): <p> <pre><code class="code"> access { type = "host"; allow = "host1 host2 ..."; (* or deny = "host1 host2 ..."; *) } </code></pre> <p> Other access control methods are not yet available.<br> </div> </body></html>