<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="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_kernel</title> </head> <body> <code class="code"><span class="keyword">sig</span><br> <span class="keyword">type</span> fatal_error =<br> [ <span class="keywordsign">`</span><span class="constructor">Broken_pipe</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Message_too_long</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Server_error</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Timeout</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Unix_error</span> <span class="keyword">of</span> <span class="constructor">Unix</span>.error ]<br> <span class="keyword">val</span> string_of_fatal_error : <span class="constructor">Nethttpd_kernel</span>.fatal_error <span class="keywordsign">-></span> string<br> <span class="keyword">type</span> bad_request_error =<br> [ <span class="keywordsign">`</span><span class="constructor">Bad_header</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Bad_header_field</span> <span class="keyword">of</span> string<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Bad_request_line</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Bad_trailer</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Format_error</span> <span class="keyword">of</span> string<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Protocol_not_supported</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Request_line_too_long</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Unexpected_eof</span> ]<br> <span class="keyword">val</span> string_of_bad_request_error :<br> <span class="constructor">Nethttpd_kernel</span>.bad_request_error <span class="keywordsign">-></span> string<br> <span class="keyword">val</span> status_of_bad_request_error :<br> <span class="constructor">Nethttpd_kernel</span>.bad_request_error <span class="keywordsign">-></span> <span class="constructor">Nethttp</span>.http_status<br> <span class="keyword">type</span> data_chunk = string * int * int<br> <span class="keyword">type</span> status_line = int * string<br> <span class="keyword">type</span> transfer_coding = [ <span class="keywordsign">`</span><span class="constructor">Chunked</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Identity</span> ]<br> <span class="keyword">type</span> resp_token =<br> [ <span class="keywordsign">`</span><span class="constructor">Resp_action</span> <span class="keyword">of</span> unit <span class="keywordsign">-></span> unit<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_body</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.data_chunk<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_end</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_header</span> <span class="keyword">of</span> <span class="constructor">Nethttp</span>.http_header<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_info_line</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.status_line * <span class="constructor">Nethttp</span>.http_header<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_status_line</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.status_line<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_trailer</span> <span class="keyword">of</span> <span class="constructor">Nethttp</span>.http_trailer ]<br> <span class="keyword">val</span> resp_100_continue : <span class="constructor">Nethttpd_kernel</span>.resp_token<br> <span class="keyword">type</span> resp_state =<br> [ <span class="keywordsign">`</span><span class="constructor">Active</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Dropped</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Error</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Inhibited</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Processed</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Queued</span> ]<br> <span class="keyword">type</span> front_token =<br> [ <span class="keywordsign">`</span><span class="constructor">Resp_end</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Resp_wire_data</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.data_chunk ]<br> <span class="keyword">exception</span> <span class="constructor">Send_queue_empty</span><br> <span class="keyword">type</span> announcement =<br> [ <span class="keywordsign">`</span><span class="constructor">As</span> <span class="keyword">of</span> string <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ignore</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ocamlnet</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Ocamlnet_and</span> <span class="keyword">of</span> string ]<br> <span class="keyword">class</span> <span class="keyword">type</span> http_response =<br> <span class="keyword">object</span><br> <span class="keyword">method</span> advance : int <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> bidirectional_phase : bool<br> <span class="keyword">method</span> close_connection : bool<br> <span class="keyword">method</span> front_token : <span class="constructor">Nethttpd_kernel</span>.front_token<br> <span class="keyword">method</span> protocol : <span class="constructor">Nethttp</span>.protocol<br> <span class="keyword">method</span> send : <span class="constructor">Nethttpd_kernel</span>.resp_token <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> send_queue_empty : bool<br> <span class="keyword">method</span> set_callback : (unit <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> set_state : <span class="constructor">Nethttpd_kernel</span>.resp_state <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> state : <span class="constructor">Nethttpd_kernel</span>.resp_state<br> <span class="keyword">method</span> transfer_encoding : <span class="constructor">Nethttpd_kernel</span>.transfer_coding<br> <span class="keyword">end</span><br> <span class="keyword">class</span> http_response_impl :<br> ?close:bool <span class="keywordsign">-></span><br> ?suppress_body:bool <span class="keywordsign">-></span><br> <span class="constructor">Nethttp</span>.protocol <span class="keywordsign">-></span> <span class="constructor">Nethttpd_kernel</span>.announcement <span class="keywordsign">-></span> http_response<br> <span class="keyword">val</span> send_static_response :<br> <span class="constructor">Nethttpd_kernel</span>.http_response <span class="keywordsign">-></span><br> <span class="constructor">Nethttp</span>.http_status <span class="keywordsign">-></span> <span class="constructor">Nethttp</span>.http_header option <span class="keywordsign">-></span> string <span class="keywordsign">-></span> unit<br> <span class="keyword">val</span> send_file_response :<br> <span class="constructor">Nethttpd_kernel</span>.http_response <span class="keywordsign">-></span><br> <span class="constructor">Nethttp</span>.http_status <span class="keywordsign">-></span><br> <span class="constructor">Nethttp</span>.http_header option <span class="keywordsign">-></span> <span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span> int64 <span class="keywordsign">-></span> unit<br> <span class="keyword">type</span> request_line = <span class="constructor">Nethttp</span>.http_method * <span class="constructor">Nethttp</span>.protocol<br> <span class="keyword">type</span> req_token =<br> [ <span class="keywordsign">`</span><span class="constructor">Bad_request_error</span> <span class="keyword">of</span><br> <span class="constructor">Nethttpd_kernel</span>.bad_request_error * <span class="constructor">Nethttpd_kernel</span>.http_response<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Eof</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Fatal_error</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.fatal_error<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Req_body</span> <span class="keyword">of</span> <span class="constructor">Nethttpd_kernel</span>.data_chunk<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Req_end</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Req_expect_100_continue</span><br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Req_header</span> <span class="keyword">of</span><br> <span class="constructor">Nethttpd_kernel</span>.request_line * <span class="constructor">Nethttp</span>.http_header *<br> <span class="constructor">Nethttpd_kernel</span>.http_response<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Req_trailer</span> <span class="keyword">of</span> <span class="constructor">Nethttp</span>.http_trailer<br> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Timeout</span> ]<br> <span class="keyword">exception</span> <span class="constructor">Recv_queue_empty</span><br> <span class="keyword">class</span> <span class="keyword">type</span> http_protocol_config =<br> <span class="keyword">object</span><br> <span class="keyword">method</span> config_announce_server : <span class="constructor">Nethttpd_kernel</span>.announcement<br> <span class="keyword">method</span> config_limit_pipeline_length : int<br> <span class="keyword">method</span> config_limit_pipeline_size : int<br> <span class="keyword">method</span> config_max_header_length : int<br> <span class="keyword">method</span> config_max_reqline_length : int<br> <span class="keyword">method</span> config_max_trailer_length : int<br> <span class="keyword">end</span><br> <span class="keyword">class</span> http_protocol :<br> <span class="keywordsign">#</span><span class="constructor">Nethttpd_kernel</span>.http_protocol_config <span class="keywordsign">-></span><br> <span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span><br> <span class="keyword">object</span><br> <span class="keyword">method</span> abort : <span class="constructor">Nethttpd_kernel</span>.fatal_error <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> config : <span class="constructor">Nethttpd_kernel</span>.http_protocol_config<br> <span class="keyword">method</span> cycle : ?block:float <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> do_input : bool<br> <span class="keyword">method</span> do_output : bool<br> <span class="keyword">method</span> fd : <span class="constructor">Unix</span>.file_descr<br> <span class="keyword">method</span> input_timeout_class : [ <span class="keywordsign">`</span><span class="constructor">Next_message</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">None</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Normal</span> ]<br> <span class="keyword">method</span> need_linger : bool<br> <span class="keyword">method</span> peek_recv : unit <span class="keywordsign">-></span> <span class="constructor">Nethttpd_kernel</span>.req_token<br> <span class="keyword">method</span> pipeline_len : int<br> <span class="keyword">method</span> receive : unit <span class="keywordsign">-></span> <span class="constructor">Nethttpd_kernel</span>.req_token<br> <span class="keyword">method</span> recv_queue_byte_size : int<br> <span class="keyword">method</span> recv_queue_len : int<br> <span class="keyword">method</span> resp_queue_len : int<br> <span class="keyword">method</span> shutdown : unit <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> test_coverage : string list<br> <span class="keyword">method</span> timeout : unit <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> waiting_for_next_message : bool<br> <span class="keyword">end</span><br> <span class="keyword">class</span> lingering_close :<br> <span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span><br> <span class="keyword">object</span><br> <span class="keyword">method</span> cycle : ?block:bool <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> unit<br> <span class="keyword">method</span> fd : <span class="constructor">Unix</span>.file_descr<br> <span class="keyword">method</span> lingering : bool<br> <span class="keyword">end</span><br> <span class="keyword">end</span></code></body></html>