<!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.Stream</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-Stream.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Network-Stream.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>Portability</th><td>non-portable (not tested)</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>Sigbjorn Finne <sigbjorn.finne@gmail.com></td></tr></table><p class="caption">Network.Stream</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>An library for creating abstract streams. Originally part of Gray's\/Bringert's
HTTP module.
</p><ul><li> Changes by Robin Bate Boerop <a href="robin@bateboerop.name">robin@bateboerop.name</a>:
- Removed unnecessary import statements.
- Moved Debug code to StreamDebugger.hs
- Moved Socket-related code to StreamSocket.hs.
</li><li> Changes by Simon Foster:
- Split Network.HTTPmodule up into to separate
Network.[Stream,TCP,HTTP] modules
</li></ul></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">class</span> <a href="#t:Stream">Stream</a> x <span class="keyword">where</span><ul class="subs"><li><a href="#v:readLine">readLine</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li><a href="#v:readBlock">readBlock</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li><a href="#v:writeBlock">writeBlock</a> :: x -> <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/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li><li><a href="#v:close">close</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li><a href="#v:closeOnEnd">closeOnEnd</a> :: x -> <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="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:ConnError">ConnError</a> <ul class="subs"><li>= <a href="#v:ErrorReset">ErrorReset</a> </li><li>| <a href="#v:ErrorClosed">ErrorClosed</a> </li><li>| <a href="#v:ErrorParse">ErrorParse</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li><li>| <a href="#v:ErrorMisc">ErrorMisc</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> </li></ul></li><li class="src short"><span class="keyword">type</span> <a href="#t:Result">Result</a> a = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Network-Stream.html#t:ConnError">ConnError</a> a</li><li class="src short"><a href="#v:bindE">bindE</a> :: <a href="Network-Stream.html#t:Result">Result</a> a -> (a -> <a href="Network-Stream.html#t:Result">Result</a> b) -> <a href="Network-Stream.html#t:Result">Result</a> b</li><li class="src short"><a href="#v:fmapE">fmapE</a> :: (a -> <a href="Network-Stream.html#t:Result">Result</a> b) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> a) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> b)</li><li class="src short"><a href="#v:failParse">failParse</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Network-Stream.html#t:Result">Result</a> a</li><li class="src short"><a href="#v:failWith">failWith</a> :: <a href="Network-Stream.html#t:ConnError">ConnError</a> -> <a href="Network-Stream.html#t:Result">Result</a> a</li><li class="src short"><a href="#v:failMisc">failMisc</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Network-Stream.html#t:Result">Result</a> a</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">class</span> <a name="t:Stream" class="def">Stream</a> x <span class="keyword">where</span><a href="src/Network-Stream.html#Stream" class="link">Source</a></p><div class="doc"><p>Streams should make layering of TLS protocol easier in future,
they allow reading/writing to files etc for debugging,
they allow use of protocols other than TCP/IP
and they allow customisation.
</p><p>Instances of this class should not trim
the input in any way, e.g. leave LF on line
endings etc. Unless that is exactly the behaviour
you want from your twisted instances ;)
</p></div><div class="subs methods"><p class="caption">Methods</p><p class="src"><a name="v:readLine" class="def">readLine</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/Network-Stream.html#readLine" class="link">Source</a></p><p class="src"><a name="v:readBlock" class="def">readBlock</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)<a href="src/Network-Stream.html#readBlock" class="link">Source</a></p><p class="src"><a name="v:writeBlock" class="def">writeBlock</a> :: x -> <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/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Network-Stream.html#writeBlock" class="link">Source</a></p><p class="src"><a name="v:close" class="def">close</a> :: x -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Network-Stream.html#close" class="link">Source</a></p><p class="src"><a name="v:closeOnEnd" class="def">closeOnEnd</a><a href="src/Network-Stream.html#closeOnEnd" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: x</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc"><p>True => shutdown the connection when response has been read / end-of-stream
has been reached.
</p></td></tr></table></div></div><div class="subs instances"><p id="control.i:Stream" class="caption collapser" onclick="toggleSection('i:Stream')">Instances</p><div id="section.i:Stream" class="show"><table><tr><td class="src"><a href="Network-Stream.html#t:Stream">Stream</a> <a href="/usr/share/doc/ghc/html/libraries/network-2.3.0.2/Network-Socket.html#t:Socket">Socket</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-Stream.html#t:Stream">Stream</a> <a href="Network-TCP.html#t:Connection">Connection</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-Stream.html#t:Stream">Stream</a> x => <a href="Network-Stream.html#t:Stream">Stream</a> (<a href="Network-StreamDebugger.html#t:StreamDebugger">StreamDebugger</a> x)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ConnError" class="def">ConnError</a> <a href="src/Network-Stream.html#ConnError" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ErrorReset" class="def">ErrorReset</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ErrorClosed" class="def">ErrorClosed</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ErrorParse" class="def">ErrorParse</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ErrorMisc" class="def">ErrorMisc</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ConnError" class="caption collapser" onclick="toggleSection('i:ConnError')">Instances</p><div id="section.i:ConnError" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Network-Stream.html#t:ConnError">ConnError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Network-Stream.html#t:ConnError">ConnError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/mtl-2.0.1.0/Control-Monad-Error-Class.html#t:Error">Error</a> <a href="Network-Stream.html#t:ConnError">ConnError</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:Result" class="def">Result</a> a = <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="Network-Stream.html#t:ConnError">ConnError</a> a<a href="src/Network-Stream.html#Result" class="link">Source</a></p><div class="doc"><p>This is the type returned by many exported network functions.
</p></div></div><div class="top"><p class="src"><a name="v:bindE" class="def">bindE</a> :: <a href="Network-Stream.html#t:Result">Result</a> a -> (a -> <a href="Network-Stream.html#t:Result">Result</a> b) -> <a href="Network-Stream.html#t:Result">Result</a> b<a href="src/Network-Stream.html#bindE" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fmapE" class="def">fmapE</a> :: (a -> <a href="Network-Stream.html#t:Result">Result</a> b) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> a) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Network-Stream.html#t:Result">Result</a> b)<a href="src/Network-Stream.html#fmapE" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:failParse" class="def">failParse</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Network-Stream.html#t:Result">Result</a> a<a href="src/Network-Stream.html#failParse" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:failWith" class="def">failWith</a> :: <a href="Network-Stream.html#t:ConnError">ConnError</a> -> <a href="Network-Stream.html#t:Result">Result</a> a<a href="src/Network-Stream.html#failWith" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:failMisc" class="def">failMisc</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Network-Stream.html#t:Result">Result</a> a<a href="src/Network-Stream.html#failMisc" class="link">Source</a></p></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>
