<!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="Ocsigen_senders.html">
<link rel="next" href="Ocsigen_extensions.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 classes" rel=Appendix href="index_classes.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="Ocsigen_cache" rel="Chapter" href="Ocsigen_cache.html">
<link title="Ocsigen_lib_base" rel="Chapter" href="Ocsigen_lib_base.html">
<link title="Ocsigen_lib" rel="Chapter" href="Ocsigen_lib.html">
<link title="Ocsigen_config" rel="Chapter" href="Ocsigen_config.html">
<link title="Ocsigen_getcommandline" rel="Chapter" href="Ocsigen_getcommandline.html">
<link title="Ocsigen_messages" rel="Chapter" href="Ocsigen_messages.html">
<link title="Ocsigen_stream" rel="Chapter" href="Ocsigen_stream.html">
<link title="Ocsigen_loader" rel="Chapter" href="Ocsigen_loader.html">
<link title="Polytables" rel="Chapter" href="Polytables.html">
<link title="Http_headers" rel="Chapter" href="Http_headers.html">
<link title="Ocsigen_http_frame" rel="Chapter" href="Ocsigen_http_frame.html">
<link title="Ocsigen_headers" rel="Chapter" href="Ocsigen_headers.html">
<link title="Framepp" rel="Chapter" href="Framepp.html">
<link title="Ocsigen_http_com" rel="Chapter" href="Ocsigen_http_com.html">
<link title="Ocsigen_charset_mime" rel="Chapter" href="Ocsigen_charset_mime.html">
<link title="Ocsigen_senders" rel="Chapter" href="Ocsigen_senders.html">
<link title="Ocsigen_cookies" rel="Chapter" href="Ocsigen_cookies.html">
<link title="Ocsigen_extensions" rel="Chapter" href="Ocsigen_extensions.html">
<link title="Ocsigen_parseconfig" rel="Chapter" href="Ocsigen_parseconfig.html">
<link title="Ocsigen_http_client" rel="Chapter" href="Ocsigen_http_client.html">
<link title="Ocsigen_local_files" rel="Chapter" href="Ocsigen_local_files.html">
<link title="Ocsigen_server" rel="Chapter" href="Ocsigen_server.html">
<link title="Ocsigen_comet" rel="Chapter" href="Ocsigen_comet.html">
<link title="Accesscontrol" rel="Chapter" href="Accesscontrol.html">
<link title="Authbasic" rel="Chapter" href="Authbasic.html">
<link title="Ocsipersist" rel="Chapter" href="Ocsipersist.html"><title>Ocsigen_cookies</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Ocsigen_senders.html" title="Ocsigen_senders">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Ocsigen_extensions.html" title="Ocsigen_extensions">Next</a>
</div>
<h1>Module <a href="type_Ocsigen_cookies.html">Ocsigen_cookies</a></h1>
<pre><span class="keyword">module</span> Ocsigen_cookies: <code class="code">sig</code> <a href="Ocsigen_cookies.html">..</a> <code class="code">end</code></pre><div class="info module top">
This table is to store cookie values for each path.
The key has type Url.path option:
it is for the path (default: root of the site),<br>
</div>
<hr width="100%">
<pre><span class="keyword">module</span> <a href="Ocsigen_cookies.CookiesTable.html">CookiesTable</a>: <code class="type">Map.S</code><code class="type"> with type key = string</code></pre>
<pre><span class="keyword">module</span> <a href="Ocsigen_cookies.Cookies.html">Cookies</a>: <code class="type">Map.S</code><code class="type"> with type key = Url.path</code></pre><div class="info">
This table is to store cookie values for each path.
</div>
<pre><code><span id="TYPEcookie"><span class="keyword">type</span> <code class="type"></code>cookie</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="TYPEELTcookie.OSet"><span class="constructor">OSet</span></span> <span class="keyword">of</span> <code class="type">float option * string * bool</code></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTcookie.OUnset"><span class="constructor">OUnset</span></span></code></td>
</tr></table>
<div class="info ">
Type used for cookies to set.
The float option is the timestamp for the expiration date.
The string is the value.
If the bool is true and the protocol is https, the cookie will be secure
(will ask the browser to send it only through secure connections).<br>
</div>
<pre><span id="TYPEcookieset"><span class="keyword">type</span> <code class="type"></code>cookieset</span> = <code class="type"><a href="Ocsigen_cookies.html#TYPEcookie">cookie</a> CookiesTable.t<br> Cookies.t</code> </pre>
<pre><span id="VALempty_cookieset"><span class="keyword">val</span> empty_cookieset</span> : <code class="type">'a CookiesTable.t Cookies.t</code></pre>
<pre><span id="VALadd_cookie"><span class="keyword">val</span> add_cookie</span> : <code class="type">Ocsigen_lib.Url.path -><br> string -><br> 'a -><br> 'a CookiesTable.t Cookies.t -><br> 'a CookiesTable.t Cookies.t</code></pre><div class="info ">
<code class="code">add_cookie path c v cookie_table</code>
adds the cookie <code class="code">c</code> to the table <code class="code">cookie_table</code>.
If the cookie is already bound, the previous binding disappear.<br>
</div>
<pre><span id="VALremove_cookie"><span class="keyword">val</span> remove_cookie</span> : <code class="type">Ocsigen_lib.Url.path -><br> string -><br> 'a CookiesTable.t Cookies.t -><br> 'a CookiesTable.t Cookies.t</code></pre><div class="info ">
<code class="code">remove_cookie c cookie_table</code> removes the cookie <code class="code">c</code>
from the table <code class="code">cookie_table</code>.
Warning: it is not equivalent to <code class="code">add_cookie ... OUnset ...</code>).<br>
</div>
<pre><span id="VALadd_cookies"><span class="keyword">val</span> add_cookies</span> : <code class="type"><a href="Ocsigen_cookies.html#TYPEcookie">cookie</a> CookiesTable.t<br> Cookies.t -><br> <a href="Ocsigen_cookies.html#TYPEcookie">cookie</a> CookiesTable.t<br> Cookies.t -><br> <a href="Ocsigen_cookies.html#TYPEcookie">cookie</a> CookiesTable.t<br> Cookies.t</code></pre><div class="info ">
<code class="code">add_cookies newcookies oldcookies</code> adds the cookies from <code class="code">newcookies</code>
to <code class="code">oldcookies</code>. If cookies are already bound in oldcookies,
the previous binding disappear.<br>
</div>
</body></html>
