<!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_intro.html"> <link rel="next" href="Netplex_mp.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 : Netplex_types</title> </head> <body> <div class="navbar"><a href="Nethttpd_intro.html">Previous</a> <a href="index.html">Up</a> <a href="Netplex_mp.html">Next</a> </div> <center><h1>Module <a href="type_Netplex_types.html">Netplex_types</a></h1></center> <br> <pre><span class="keyword">module</span> Netplex_types: <code class="code">sig</code> <a href="Netplex_types.html">..</a> <code class="code">end</code></pre>Types for <code class="code">Netplex</code><br> <hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEparam_value"></a><code class="type"></code>param_value = <code class="type">[ `Bool of bool | `Float of float | `Int of int | `String of string ]</code> </pre> <pre><span class="keyword">type</span> <a name="TYPEparam_value_or_any"></a><code class="type"></code>param_value_or_any = <code class="type">[ `Any of exn<br> | `Bool of bool<br> | `Float of float<br> | `Int of int<br> | `String of string ]</code> </pre> <pre><span class="keyword">type</span> <a name="TYPElevel"></a><code class="type"></code>level = <code class="type">[ `Alert | `Crit | `Debug | `Emerg | `Err | `Info | `Notice | `Warning ]</code> </pre> <pre><span class="keyword">class type</span> <a name="TYPElogger"></a><a href="Netplex_types.logger.html">logger</a> = <code class="code">object</code> <a href="Netplex_types.logger.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">type</span> <a name="TYPEparallelization_type"></a><code class="type"></code>parallelization_type = <code class="type">[ `Controller_attached | `Multi_processing | `Multi_threading ]</code> </pre> <div class="info"> Type of parallelization:<ul> <li><code class="code">`Multi_processing</code> on a single host</li> <li><code class="code">`Multi_threading</code> on a single host</li> <li><code class="code">`Controller_attached</code> means that the service runs within the controller. This is (for now) only allowed for controller-internal services.</li> </ul> <br> </div> <pre><span class="keyword">type</span> <a name="TYPEsocket_state"></a><code class="type"></code>socket_state = <code class="type">[ `Disabled | `Down | `Enabled | `Restarting of bool ]</code> </pre> <div class="info"> The state of a socket:<ul> <li><code class="code">`Enabled</code>: The controller allows containers to accept connections. Note that this does not necessarily means that there such containers.</li> <li><code class="code">`Disabled</code>: It is not allowed to accept new connections. The socket is kept open, however.</li> <li><code class="code">`Restarting b</code>: The containers are being restarted. The boolean argument says whether the socket will be enabled after that.</li> <li><code class="code">`Down</code>: The socket is down/closed</li> </ul> <br> </div> <pre><span class="keyword">type</span> <a name="TYPEcontainer_id"></a><code class="type"></code>container_id = <code class="type">< ></code> </pre> <div class="info"> Identifies a container<br> </div> <pre><span class="keyword">type</span> <a name="TYPEcontainer_state"></a><code class="type"></code>container_state = <code class="type">[ `Accepting of int * float | `Busy | `Shutting_down | `Starting of float ]</code> </pre> <div class="info"> The container state for workload management:<ul> <li><code class="code">`Accepting(n,t)</code>: The container is accepting further connections. It currently processes <code class="code">n</code> connections. The last connection was accepted at time <code class="code">t</code> (seconds since the epoch).</li> <li><code class="code">`Busy</code>: The container does not accept connections</li> <li><code class="code">`Starting t</code>: The container was started at time <code class="code">t</code> and is not yet ready.</li> <li><code class="code">`Shutting_down</code>: The container is being shutted down.</li> </ul> <br> </div> <pre><span class="keyword">type</span> <a name="TYPEcapacity"></a><code class="type"></code>capacity = <code class="type">[ `Low_quality of int | `Normal_quality of int | `Unavailable ]</code> </pre> <div class="info"> How many connections a container can accept in addition to the existing connections:<ul> <li><code class="code">`Normal_quality n</code>: It can accept n connections with normal service quality, <code class="code">n > 0</code></li> <li><code class="code">`Low_quality n</code>: It can accept n connections with low service quality (e.g. because it is already quite loaded), <code class="code">n > 0</code></li> <li><code class="code">`Unavailable</code>: No capacity free</li> </ul> <br> </div> <pre><span class="keyword">class type</span> <a name="TYPEcontroller"></a><a href="Netplex_types.controller.html">controller</a> = <code class="code">object</code> <a href="Netplex_types.controller.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEcontroller_config"></a><a href="Netplex_types.controller_config.html">controller_config</a> = <code class="code">object</code> <a href="Netplex_types.controller_config.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEsocket_service"></a><a href="Netplex_types.socket_service.html">socket_service</a> = <code class="code">object</code> <a href="Netplex_types.socket_service.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEsocket_service_config"></a><a href="Netplex_types.socket_service_config.html">socket_service_config</a> = <code class="code">object</code> <a href="Netplex_types.socket_service_config.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEprotocol"></a><a href="Netplex_types.protocol.html">protocol</a> = <code class="code">object</code> <a href="Netplex_types.protocol.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEsocket_controller"></a><a href="Netplex_types.socket_controller.html">socket_controller</a> = <code class="code">object</code> <a href="Netplex_types.socket_controller.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEprocessor_hooks"></a><a href="Netplex_types.processor_hooks.html">processor_hooks</a> = <code class="code">object</code> <a href="Netplex_types.processor_hooks.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEprocessor"></a><a href="Netplex_types.processor.html">processor</a> = <code class="code">object</code> <a href="Netplex_types.processor.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEcontainer"></a><a href="Netplex_types.container.html">container</a> = <code class="code">object</code> <a href="Netplex_types.container.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEworkload_manager"></a><a href="Netplex_types.workload_manager.html">workload_manager</a> = <code class="code">object</code> <a href="Netplex_types.workload_manager.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEpar_thread"></a><a href="Netplex_types.par_thread.html">par_thread</a> = <code class="code">object</code> <a href="Netplex_types.par_thread.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEparallelizer"></a><a href="Netplex_types.parallelizer.html">parallelizer</a> = <code class="code">object</code> <a href="Netplex_types.parallelizer.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">type</span> <a name="TYPEconfig_tree"></a><code class="type"></code>config_tree = <code class="type">[ `Parameter of <a href="Netplex_types.html#TYPEaddress">address</a> * string * <a href="Netplex_types.html#TYPEparam_value">param_value</a><br> | `Section of <a href="Netplex_types.html#TYPEaddress">address</a> * string * <a href="Netplex_types.html#TYPEconfig_tree">config_tree</a> list ]</code> </pre> <pre><span class="keyword">type</span> <a name="TYPEaddress"></a><code class="type"></code>address = <code class="type">< ></code> </pre> <pre><span class="keyword">class type</span> <a name="TYPEconfig_file"></a><a href="Netplex_types.config_file.html">config_file</a> = <code class="code">object</code> <a href="Netplex_types.config_file.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEprocessor_factory"></a><a href="Netplex_types.processor_factory.html">processor_factory</a> = <code class="code">object</code> <a href="Netplex_types.processor_factory.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEworkload_manager_factory"></a><a href="Netplex_types.workload_manager_factory.html">workload_manager_factory</a> = <code class="code">object</code> <a href="Netplex_types.workload_manager_factory.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPElogger_factory"></a><a href="Netplex_types.logger_factory.html">logger_factory</a> = <code class="code">object</code> <a href="Netplex_types.logger_factory.html">..</a> <code class="code">end</code></pre><pre><span class="keyword">class type</span> <a name="TYPEnetplex_config"></a><a href="Netplex_types.netplex_config.html">netplex_config</a> = <code class="code">object</code> <a href="Netplex_types.netplex_config.html">..</a> <code class="code">end</code></pre></body></html>
