Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
82 lines (80 sloc) 4.07 KB
<html>
<h1>Mod_neko</h1>
<p>
Apache access when running inside mod_neko.
</p>
<doc_blk>
<doc_type>#list</doc_type> <doc_name>get_cookies</doc_name><doc_type>()</doc_type> <doc_doc>Return a cookie list as a (name,value) chained list</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>set_cookie</doc_name><doc_type>(name : string, val : string)</doc_type> <doc_doc>Set a cookie</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_host_name</doc_name><doc_type>()</doc_type> <doc_doc>Get the local host IP</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_client_ip</doc_name><doc_type>()</doc_type> <doc_doc>Get the connected client IP</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_uri</doc_name><doc_type>()</doc_type> <doc_doc>Get the original URI requested by the client (before any internal redirection)</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>redirect</doc_name><doc_type>(string)</doc_type> <doc_doc>Redirect the client to another page (Location header)</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>set_return_code</doc_name><doc_type>(int)</doc_type> <doc_doc>Set the HTTP return code</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>set_header</doc_name><doc_type>(name : string, val : string)</doc_type> <doc_doc>Set a HTTP header value</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string?</doc_type> <doc_name>get_client_header</doc_name><doc_type>(name : string)</doc_type> <doc_doc>Get a HTTP header sent by the client</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string list</doc_type> <doc_name>get_client_headers</doc_name><doc_type>()</doc_type> <doc_doc>Get all the HTTP client headers</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_params_string</doc_name><doc_type>()</doc_type> <doc_doc>Return the whole parameters string</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_post_data</doc_name><doc_type>()</doc_type> <doc_doc>Return the whole unparsed POST string</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>parse_multipart_data</doc_name><doc_type>(onpart : function:2, ondata : function:3)</doc_type> <doc_doc>
Incrementally parse the multipart data. call <doc_code>onpart(name,filename)</doc_code> for each part
found and <doc_code>ondata(buf,pos,len)</doc_code> when some data is available
</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>#list</doc_type> <doc_name>get_params</doc_name><doc_type>()</doc_type> <doc_doc>parse all GET and POST params and return them into a chained list</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>cgi_get_cwd</doc_name><doc_type>()</doc_type> <doc_doc>Return current bytecode file working directory</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>cgi_set_main</doc_name><doc_type>(function:0?)</doc_type> <doc_doc>Set the main entry point function</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>cgi_flush</doc_name><doc_type>()</doc_type> <doc_doc>Flush the data written so it's immediatly sent to the client</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>object</doc_type> <doc_name>cgi_get_config</doc_name><doc_type>()</doc_type> <doc_doc>Return the current configuration</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>cgi_set_config</doc_name><doc_type>(object)</doc_type> <doc_doc>Set the current configuration</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>any</doc_type> <doc_name>cgi_command</doc_name><doc_type>(any)</doc_type> <doc_doc>Perform a configuration-specific command :
<ul>
<li>stats : returns the statistics</li>
<li>cache : returns the current cache</li>
</ul>
</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>string</doc_type> <doc_name>get_http_method</doc_name><doc_type>()</doc_type> <doc_doc>Returns the http method (GET,POST...) used by the client</doc_doc>
</doc_blk>
<doc_blk>
<doc_type>void</doc_type> <doc_name>log_message</doc_name><doc_type>(string)</doc_type> <doc_doc>Write the message into the apache log</doc_doc>
</doc_blk>
</html>