<!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_comet.Channels.html">
<link rel="Up" href="Ocsigen_comet.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_comet.Security</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Ocsigen_comet.Channels.html" title="Ocsigen_comet.Channels">Previous</a>
<a class="up" href="Ocsigen_comet.html" title="Ocsigen_comet">Up</a>
</div>
<h1>Module <a href="type_Ocsigen_comet.Security.html">Ocsigen_comet.Security</a></h1>
<pre><span class="keyword">module</span> Security: <code class="code">sig</code> <a href="Ocsigen_comet.Security.html">..</a> <code class="code">end</code></pre><hr width="100%">
<pre><span id="VALset_timeout"><span class="keyword">val</span> set_timeout</span> : <code class="type">?reset:bool -> float -> unit</code></pre><div class="info ">
<code class="code">set_timeout ?reset f</code> sets the timeout value for future Comet connections
to <code class="code">f</code>. If <code class="code">reset</code> is <code class="code">true</code> then current connections are closed and the
new timeout value will apply to the reopened connections. Default value
for <code class="code">reset</code> is false.<br>
</div>
<pre><span id="VALdeactivate"><span class="keyword">val</span> deactivate</span> : <code class="type">unit -> unit</code></pre><div class="info ">
<code class="code">deactivate ()</code> ceases all Comet related activity. Each opened connection
is closed. Further attempts to connect to the server with a Comet specific
content type will result in a HTTP status code 503 (Unavailable).
If called when Comet is not activated it does nothing (not even logging
the deactivation attempt.<br>
</div>
<pre><span id="VALactivate"><span class="keyword">val</span> activate</span> : <code class="type">unit -> unit</code></pre><div class="info ">
<code class="code">activate ()</code> starts serving Comet requests. It is the client's own
responsibility to reopen a connection. If Comet was already activated it
keeps going and nothing happens.<br>
</div>
<pre><span id="VALactivated"><span class="keyword">val</span> activated</span> : <code class="type">unit -> bool</code></pre><div class="info ">
<code class="code">activated ()</code> reflects the activation state of the Comet
module. If <code class="code">false</code> it indicates that Comet connections are answered with a
HTTP status code 503. If <code class="code">true</code> it indicates that Comet connections are
handled in a standard fashion by the server.<br>
</div>
</body></html>
