Network.Stream

An library for creating abstract streams. Originally part of Gray's\/Bringert's HTTP module.

• Changes by Robin Bate Boerop [e-mail]:
• Removed unnecessary import statements.
• Moved Debug code to StreamDebugger.hs
• Moved Socket-related code to StreamSocket.hs.
• Changes by Simon Foster:
• Split Network.HTTPmodule up into to separate Network.[Stream,TCP,HTTP] modules

Documentation

class Stream x where

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.

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 ;)

Methods

readLine :: x -> IO (Result String)

readBlock :: x -> Int -> IO (Result String)

writeBlock :: x -> String -> IO (Result ())

close :: x -> IO ()

closeOnEnd

Arguments

:: x

-> Bool

-> IO ()

True => shutdown the connection when response has been read / end-of-stream has been reached.

Instances

Stream Socket

Defined in Network.StreamSocket

Methods

readLine :: Socket -> IO (Result String)

readBlock :: Socket -> Int -> IO (Result String)

writeBlock :: Socket -> String -> IO (Result ())

close :: Socket -> IO ()

closeOnEnd :: Socket -> Bool -> IO ()

Stream Connection

Defined in Network.TCP

Methods

readLine :: Connection -> IO (Result String)

readBlock :: Connection -> Int -> IO (Result String)

writeBlock :: Connection -> String -> IO (Result ())

close :: Connection -> IO ()

closeOnEnd :: Connection -> Bool -> IO ()

Stream x => Stream (StreamDebugger x)

Defined in Network.StreamDebugger

Methods

readLine :: StreamDebugger x -> IO (Result String)

readBlock :: StreamDebugger x -> Int -> IO (Result String)

writeBlock :: StreamDebugger x -> String -> IO (Result ())

close :: StreamDebugger x -> IO ()

closeOnEnd :: StreamDebugger x -> Bool -> IO ()

data ConnError

Constructors

ErrorReset

ErrorClosed

ErrorParse String

ErrorMisc String

Instances

Eq ConnError

Defined in Network.Stream

Methods

(==) :: ConnError -> ConnError -> Bool

(/=) :: ConnError -> ConnError -> Bool

Show ConnError

Defined in Network.Stream

Methods

showsPrec :: Int -> ConnError -> ShowS

show :: ConnError -> String

showList :: [ConnError] -> ShowS

Error ConnError

Defined in Network.Stream

Methods

noMsg :: ConnError

strMsg :: String -> ConnError

type Result a = Either ConnError a

This is the type returned by many exported network functions.

bindE :: Result a -> (a -> Result b) -> Result b

fmapE :: (a -> Result b) -> IO (Result a) -> IO (Result b)

failParse :: String -> Result a

failWith :: ConnError -> Result a

failMisc :: String -> Result a