Ketchup-0.3: docs/Ketchup-Httpd.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>Ketchup.Httpd</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_Ketchup-Httpd.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption empty"> </p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Ketchup.Httpd</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:HTTPRequest">HTTPRequest</a> = <a href="#v:HTTPRequest">HTTPRequest</a> {<ul class="subs"><li><a href="#v:method">method</a> ∷ ByteString</li><li><a href="#v:uri">uri</a> ∷ ByteString</li><li><a href="#v:httpver">httpver</a> ∷ ByteString</li><li><a href="#v:headers">headers</a> ∷ <a href="Ketchup-Httpd.html#t:Headers">Headers</a></li><li><a href="#v:body">body</a> ∷ ByteString</li></ul>}</li><li class="src short"><span class="keyword">type</span> <a href="#t:Headers">Headers</a> = [(ByteString, [ByteString])]</li><li class="src short"><span class="keyword">type</span> <a href="#t:Handler">Handler</a> = Socket → <a href="Ketchup-Httpd.html#t:HTTPRequest">HTTPRequest</a> → IO ()</li><li class="src short"><a href="#v:listenHTTP">listenHTTP</a> ∷ String → PortNumber → <a href="Ketchup-Httpd.html#t:Handler">Handler</a> → IO ()</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:HTTPRequest" class="def">HTTPRequest</a> </p><div class="doc"><p>HTTP Request type
This holds a complete HTTP request
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:HTTPRequest" class="def">HTTPRequest</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:method" class="def">method</a> ∷ ByteString</dt><dd class="doc"><p>Get HTTP Request Method (GET, POST etc.)
</p></dd><dt class="src"><a name="v:uri" class="def">uri</a> ∷ ByteString</dt><dd class="doc"><p>Get Request URI
</p></dd><dt class="src"><a name="v:httpver" class="def">httpver</a> ∷ ByteString</dt><dd class="doc"><p>Get HTTP Version
</p></dd><dt class="src"><a name="v:headers" class="def">headers</a> ∷ <a href="Ketchup-Httpd.html#t:Headers">Headers</a></dt><dd class="doc"><p>Get HTTP Headers (header, [values])
</p></dd><dt class="src"><a name="v:body" class="def">body</a> ∷ ByteString</dt><dd class="doc"><p>Get HTTP Post body (raw string)
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:HTTPRequest" class="caption collapser" onclick="toggleSection('i:HTTPRequest')">Instances</p><div id="section.i:HTTPRequest" class="show"><table><tr><td class="src">Show <a href="Ketchup-Httpd.html#t:HTTPRequest">HTTPRequest</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Headers" class="def">Headers</a> = [(ByteString, [ByteString])]</p></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:Handler" class="def">Handler</a> = Socket → <a href="Ketchup-Httpd.html#t:HTTPRequest">HTTPRequest</a> → IO ()</p></div><div class="top"><p class="src"><a name="v:listenHTTP" class="def">listenHTTP</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">∷ String</td><td class="doc"><p>Address to bind (ie. <a href="*.html">*</a>)
</p></td></tr><tr><td class="src">→ PortNumber</td><td class="doc"><p>Port to listen on
</p></td></tr><tr><td class="src">→ <a href="Ketchup-Httpd.html#t:Handler">Handler</a></td><td class="doc"><p>Route function to call
</p></td></tr><tr><td class="src">→ IO ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Listens for incoming HTTP request
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>