<!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="WebGL.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 methods" rel=Appendix href="index_methods.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="CSS" rel="Chapter" href="CSS.html">
<link title="Dom" rel="Chapter" href="Dom.html">
<link title="Dom_events" rel="Chapter" href="Dom_events.html">
<link title="Dom_html" rel="Chapter" href="Dom_html.html">
<link title="Event_arrows" rel="Chapter" href="Event_arrows.html">
<link title="File" rel="Chapter" href="File.html">
<link title="Firebug" rel="Chapter" href="Firebug.html">
<link title="Form" rel="Chapter" href="Form.html">
<link title="Js" rel="Chapter" href="Js.html">
<link title="Json" rel="Chapter" href="Json.html">
<link title="Lwt_js" rel="Chapter" href="Lwt_js.html">
<link title="Lwt_js_events" rel="Chapter" href="Lwt_js_events.html">
<link title="Regexp" rel="Chapter" href="Regexp.html">
<link title="Typed_array" rel="Chapter" href="Typed_array.html">
<link title="Url" rel="Chapter" href="Url.html">
<link title="WebGL" rel="Chapter" href="WebGL.html">
<link title="XmlHttpRequest" rel="Chapter" href="XmlHttpRequest.html"><title>XmlHttpRequest</title>
</head>
<body>
<div class="navbar"><a class="pre" href="WebGL.html" title="WebGL">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Module <a href="type_XmlHttpRequest.html">XmlHttpRequest</a></h1>
<pre><span class="keyword">module</span> XmlHttpRequest: <code class="code">sig</code> <a href="XmlHttpRequest.html">..</a> <code class="code">end</code></pre><div class="info">
XmlHttpRequest object.<br>
</div>
<hr width="100%">
<pre><code><span id="TYPEreadyState"><span class="keyword">type</span> <code class="type"></code>readyState</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTreadyState.UNSENT"><span class="constructor">UNSENT</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTreadyState.OPENED"><span class="constructor">OPENED</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTreadyState.HEADERS_RECEIVED"><span class="constructor">HEADERS_RECEIVED</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTreadyState.LOADING"><span class="constructor">LOADING</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTreadyState.DONE"><span class="constructor">DONE</span></span></code></td>
</tr></table>
<pre><span id="TYPExmlHttpRequest"><span class="keyword">class type</span> <a href="XmlHttpRequest.xmlHttpRequest-c.html">xmlHttpRequest</a></span> = <code class="code">object</code> <a href="XmlHttpRequest.xmlHttpRequest-c.html">..</a> <code class="code">end</code></pre><pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">unit -> <a href="XmlHttpRequest.xmlHttpRequest-c.html">xmlHttpRequest</a> <a href="Js.html#TYPEt">Js.t</a></code></pre><br>
The next part of this module allow one to use Ocaml with no need for
Javascript documentation.<br>
<pre><span class="keyword">module</span> <a href="XmlHttpRequest.Event.html">Event</a>: <code class="code">sig</code> <a href="XmlHttpRequest.Event.html">..</a> <code class="code">end</code></pre><pre><code><span id="TYPEhttp_frame"><span class="keyword">type</span> <code class="type"></code>http_frame</span> = {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThttp_frame.url">url</span> :<code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThttp_frame.code">code</span> :<code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThttp_frame.headers">headers</span> :<code class="type">string -> string option</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThttp_frame.content">content</span> :<code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELThttp_frame.content_xml">content_xml</span> :<code class="type">unit -> <a href="Dom.element-c.html">Dom.element</a> <a href="Dom.document-c.html">Dom.document</a> <a href="Js.html#TYPEt">Js.t</a> option</code>;</code></td>
</tr></table>
}
<div class="info">
The type for XHR results. The code field is the http status code of the
answer. The headers field is a function associating values to any header
name.<br>
</div>
<pre><span id="EXCEPTIONWrong_headers"><span class="keyword">exception</span> Wrong_headers</span> <span class="keyword">of</span> <code class="type">(int * (string -> string option))</code></pre>
<div class="info">
The exception raise by perform functions when the check_headers
parameter returned false. The parameter of the exception is a
function is like the <code class="code">headers</code> function of <code class="code">http_frame</code><br>
</div>
<pre><span id="VALperform_raw_url"><span class="keyword">val</span> perform_raw_url</span> : <code class="type">?headers:(string * string) list -><br> ?content_type:string -><br> ?post_args:(string * string) list -><br> ?get_args:(string * string) list -><br> ?form_arg:<a href="Form.html#TYPEform_contents">Form.form_contents</a> -><br> ?check_headers:(int -> (string -> string option) -> bool) -><br> string -> <a href="XmlHttpRequest.html#TYPEhttp_frame">http_frame</a> Lwt.t</code></pre><div class="info">
<code class="code">perform_raw_url ?headers ?content_type ?post_args ?get_args ?form_arg url</code>
makes an asynchronous request to the specified <code class="code">url</code> with
specified options. The result is a cancelable thread returning
an HTTP frame. If <code class="code">post_args</code> and <code class="code">form_arg</code> are <code class="code">None</code>, a GET request is
used. If <code class="code">post_args</code> or <code class="code">form_arg</code> is <code class="code">Some _</code> (even <code class="code">Some []</code>) then a POST
request is made. The <code class="code">check_headers</code> argument is run as soon as the answer
code and headers are available. If it returns false, the request is canceled
and the functions raise the <code class="code">Wrong_headers</code> exception<br>
</div>
<pre><span id="VALperform"><span class="keyword">val</span> perform</span> : <code class="type">?headers:(string * string) list -><br> ?content_type:string -><br> ?post_args:(string * string) list -><br> ?get_args:(string * string) list -><br> ?form_arg:<a href="Form.html#TYPEform_contents">Form.form_contents</a> -><br> ?check_headers:(int -> (string -> string option) -> bool) -><br> <a href="Url.html#TYPEurl">Url.url</a> -> <a href="XmlHttpRequest.html#TYPEhttp_frame">http_frame</a> Lwt.t</code></pre><div class="info">
<code class="code">perform</code> is the same as <a href="XmlHttpRequest.html#VALperform_raw_url"><code class="code">XmlHttpRequest.perform_raw_url</code></a> except that the Url argument has type
<a href="Url.html#TYPEurl"><code class="code">Url.url</code></a>.<br>
</div>
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">string -> <a href="XmlHttpRequest.html#TYPEhttp_frame">http_frame</a> Lwt.t</code></pre><div class="info">
<code class="code">get url</code> makes an asynchronous request to the specified <code class="code">url</code><br>
</div>
</body></html>
distrib
>
Fedora
>
18
>
x86_64
>
media
>
updates
>
by-pkgid
>
3866615ed9f87500bac83f78574eecc8
>
files
>
154
