<!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>Network.HTTP.Proxy</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Network-HTTP-Proxy.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Network-HTTP-Proxy.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">HTTP-4000.1.1: A library for client-side HTTP</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Maintainer</th><td>Sigbjorn Finne <sigbjorn.finne@gmail.com></td></tr></table><p class="caption">Network.HTTP.Proxy</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Author : Eric Kow <a href="E.Y.Kow@brighton.ac.uk">E.Y.Kow@brighton.ac.uk</a>
Stability : experimental
Portability : non-portable (not tested)
</p><p>Handling proxy server settings and their resolution.
</p></div></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:Proxy">Proxy</a> <ul class="subs"><li>= <a href="#v:NoProxy">NoProxy</a> </li><li>| <a href="#v:Proxy">Proxy</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Authority">Authority</a>) </li></ul></li><li class="src short"><a href="#v:noProxy">noProxy</a> :: <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a></li><li class="src short"><a href="#v:fetchProxy">fetchProxy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a></li><li class="src short"><a href="#v:parseProxy">parseProxy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Proxy" class="def">Proxy</a> <a href="src/Network-HTTP-Proxy.html#Proxy" class="link">Source</a></p><div class="doc"><p>HTTP proxies (or not) are represented via <code><a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a></code>, specifying if a
proxy should be used for the request (see <code>Network.Browser.setProxy</code>)
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:NoProxy" class="def">NoProxy</a></td><td class="doc"><p>Don't use a proxy.
</p></td></tr><tr><td class="src"><a name="v:Proxy" class="def">Proxy</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Auth.html#t:Authority">Authority</a>)</td><td class="doc"><p>Use the proxy given. Should be of the
form <a href="http://host:port.html">http://host:port</a>, <a href="host.html">host</a>, <a href="host:port.html">host:port</a>, or <a href="http://host.html">http://host</a>.
Additionally, an optional <code><a href="Network-HTTP-Auth.html#t:Authority">Authority</a></code> for authentication with the proxy.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:noProxy" class="def">noProxy</a> :: <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a><a href="src/Network-HTTP-Proxy.html#noProxy" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fetchProxy" class="def">fetchProxy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a><a href="src/Network-HTTP-Proxy.html#fetchProxy" class="link">Source</a></p><div class="doc"><p><code>fetchProxy flg</code> gets the local proxy settings and parse the string
into a <code>Proxy</code> value. If you want to be informed of ill-formed proxy
configuration strings, supply <code>True</code> for <code>flg</code>.
Proxy settings are sourced from the <code>HTTP_PROXY</code> environment variable,
and in the case of Windows platforms, by consulting IE/WinInet's proxy
setting in the Registry.
</p></div></div><div class="top"><p class="src"><a name="v:parseProxy" class="def">parseProxy</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Network-HTTP-Proxy.html#t:Proxy">Proxy</a><a href="src/Network-HTTP-Proxy.html#parseProxy" class="link">Source</a></p><div class="doc"><p><code>parseProxy str</code> translates a proxy server string into a <code>Proxy</code> value;
returns <code>Nothing</code> if not well-formed.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
