<!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="Netcgi_common.cgi_environment.html"> <link rel="Up" href="Netcgi_common.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 : Netcgi_common.cgi</title> </head> <body> <div class="navbar"><a href="Netcgi_common.cgi_environment.html">Previous</a> <a href="Netcgi_common.html">Up</a> </div> <center><h1>Class <a href="type_Netcgi_common.cgi.html">Netcgi_common.cgi</a></h1></center> <br> <pre><span class="keyword">class</span> <a name="TYPEcgi"></a>cgi : <code class="type"><a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -> <a href="Netcgi_common.html#TYPEoutput_type">output_type</a> -> <a href="Netcgi_common.html#TYPErequest_method">request_method</a> -> <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list -> </code><code class="code">object</code> <a href="Netcgi_common.cgi.html">..</a> <code class="code">end</code></pre><code class="code">cgi env op meth args</code> constructs <a href="Netcgi.cgi.html"><code class="code">Netcgi.cgi</code></a> objects. The environment <code class="code">#out_channel</code> is wrapped into a transactional channel or a discarding channel according to <code class="code">op</code> (<code class="code">`Direct</code> or <code class="code">`Transactional</code>) and <code class="code">request_method</code> (<code class="code">`HEAD</code> requests must only return a header). For standard cases, when POST and PUT arguments are available through a <code class="code">Netchannels.in_obj_channel</code>, we recommend you use <a href="Netcgi_common.html#VALcgi_with_args"><code class="code">Netcgi_common.cgi_with_args</code></a> that will parse the arguments for you and check preconditions. <p> Remark: You may think that the argument <code class="code">meth</code> is superfluous as it can be deduced from <code class="code">env#cgi_request_method</code>. While it is true for <code class="code">`DELETE</code>, <code class="code">`GET</code>, <code class="code">`HEAD</code> and <code class="code">`POST</code>, the <code class="code">`PUT</code> takes a <a href="Netcgi_common.cgi_argument.html"><code class="code">Netcgi_common.cgi_argument</code></a> parameter. Setting correctly this parameter and decoding <code class="code">env#cgi_request_method</code> is done for you by <a href="Netcgi_common.html#VALcgi_with_args"><code class="code">Netcgi_common.cgi_with_args</code></a>.<br> <hr width="100%"> <pre><span class="keyword">method</span> <a name="METHODargument"></a>argument : <code class="type">string -> <a href="Netcgi_common.cgi_argument.html">cgi_argument</a></code></pre><pre><span class="keyword">method</span> <a name="METHODargument_value"></a>argument_value : <code class="type">?default:string -> string -> string</code></pre><pre><span class="keyword">method</span> <a name="METHODargument_exists"></a>argument_exists : <code class="type">string -> bool</code></pre><pre><span class="keyword">method</span> <a name="METHODmultiple_argument"></a>multiple_argument : <code class="type">string -> <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list</code></pre><pre><span class="keyword">method</span> <a name="METHODarguments"></a>arguments : <code class="type"><a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list</code></pre><pre><span class="keyword">method</span> <a name="METHODenvironment"></a>environment : <code class="type"><a href="Netcgi_common.cgi_environment.html">cgi_environment</a></code></pre><pre><span class="keyword">method</span> <a name="METHODrequest_method"></a>request_method : <code class="type"><a href="Netcgi_common.html#TYPErequest_method">request_method</a></code></pre><pre><span class="keyword">method</span> <a name="METHODfinalize"></a>finalize : <code class="type">unit -> unit</code></pre><pre><span class="keyword">method</span> <a name="METHODurl"></a>url : <code class="type">?protocol:<a href="Nethttp.html#TYPEprotocol">Nethttp.protocol</a> -><br> ?with_authority:<a href="Netcgi_common.html#TYPEother_url_spec">other_url_spec</a> -><br> ?with_script_name:<a href="Netcgi_common.html#TYPEother_url_spec">other_url_spec</a> -><br> ?with_path_info:<a href="Netcgi_common.html#TYPEother_url_spec">other_url_spec</a> -><br> ?with_query_string:<a href="Netcgi_common.html#TYPEquery_string_spec">query_string_spec</a> -> unit -> string</code></pre><div class="info"> The following environment properties must be available for this method to work properly (please make sure your connector provides them; the CGI spec make them compulsory anyway):<ul> <li><code class="code">cgi_server_name</code></li> <li><code class="code">cgi_server_port</code></li> <li><code class="code">cgi_script_name</code></li> <li><code class="code">cgi_path_info</code></li> </ul> <br> </div> <pre><span class="keyword">method</span> <a name="METHODset_header"></a>set_header : <code class="type">?status:<a href="Nethttp.html#TYPEhttp_status">Nethttp.http_status</a> -><br> ?content_type:string -><br> ?content_length:int -><br> ?set_cookie:<a href="Nethttp.html#TYPEcookie">Nethttp.cookie</a> list -><br> ?set_cookies:<a href="Netcgi_common.Cookie.html#TYPEt">Cookie.t</a> list -><br> ?cache:<a href="Netcgi_common.html#TYPEcache_control">cache_control</a> -><br> ?filename:string -><br> ?language:string -><br> ?script_type:string -><br> ?style_type:string -> ?fields:(string * string list) list -> unit -> unit</code></pre><pre><span class="keyword">method</span> <a name="METHODset_redirection_header"></a>set_redirection_header : <code class="type">?set_cookies:<a href="Netcgi_common.Cookie.html#TYPEt">Cookie.t</a> list -><br> ?fields:(string * string list) list -> string -> unit</code></pre><pre><span class="keyword">method</span> <a name="METHODoutput"></a>output : <code class="type"><a href="Netchannels.trans_out_obj_channel.html">Netchannels.trans_out_obj_channel</a></code></pre><div class="info"> <span class="warning">Deprecated.</span>Use <code class="code">#out_channel</code> instead.<br> </div> <pre><span class="keyword">method</span> <a name="METHODout_channel"></a>out_channel : <code class="type"><a href="Netchannels.trans_out_obj_channel.html">Netchannels.trans_out_obj_channel</a></code></pre><pre><span class="keyword">method</span> <a name="METHODat_exit"></a>at_exit : <code class="type">(unit -> unit) -> unit</code></pre></body></html>