/usr/share/doc/libghc-servant-doc/html/Servant-API-IsSecure.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Servant.API.IsSecure</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Servant-API-IsSecure.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Servant-API-IsSecure.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">servant-0.8.1: A family of combinators for defining webservices APIs</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Servant.API.IsSecure</p></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:IsSecure">IsSecure</a><ul class="subs"><li>= <a href="#v:Secure">Secure</a></li><li>| <a href="#v:NotSecure">NotSecure</a></li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="doc"><p>| Use <code><a href="Servant-API-IsSecure.html#t:IsSecure">IsSecure</a></code> whenever your request handlers need to know whether
   the connection to the server is secure or not.
   This would make the request handlers receive an argument of type <code><a href="Servant-API-IsSecure.html#t:IsSecure">IsSecure</a></code>,
   whose value can be one of <code><a href="Servant-API-IsSecure.html#v:Secure">Secure</a></code> (HTTPS) or <code><a href="Servant-API-IsSecure.html#v:NotSecure">NotSecure</a></code> (HTTP).</p><p>Example:</p><pre class="screen"><code class="prompt">&gt;&gt;&gt; </code><strong class="userinput"><code>type API = &quot;sensitive-data&quot; :&gt; IsSecure :&gt; Get '[JSON] NationSecrets
</code></strong></pre></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:IsSecure" class="def">IsSecure</a> <a href="src/Servant-API-IsSecure.html#IsSecure" class="link">Source</a> <a href="#t:IsSecure" class="selflink">#</a></p><div class="doc"><p>Was this request made over an SSL connection?</p><p>Note that this value will not tell you if the client originally
 made this request over SSL, but rather whether the current
 connection is SSL. The distinction lies with reverse proxies.
 In many cases, the client will connect to a load balancer over SSL,
 but connect to the WAI handler without SSL. In such a case,
 the handlers would get <code><a href="Servant-API-IsSecure.html#v:NotSecure">NotSecure</a></code>, but from a user perspective,
 there is a secure connection.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:Secure" class="def">Secure</a></td><td class="doc"><p>the connection to the server
   is secure (HTTPS)</p></td></tr><tr><td class="src"><a id="v:NotSecure" class="def">NotSecure</a></td><td class="doc"><p>the connection to the server
   is not secure (HTTP)</p></td></tr></table></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
libghc-servant-doc 0.8.1-2 / usr / share / doc / libghc-servant-doc / html / Servant-API-IsSecure.html
