HTTP-3001.0.3Source codeContentsIndex
Network.Stream
Portabilitynon-portable (not tested)
Stabilityexperimental
Maintainerbjorn@bringert.net
Contents
Streams
Errors
Description

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

  • Changes by Simon Foster: - Split module up into to sepearate Network.[Stream,TCP,HTTP] modules
Synopsis
data Debug x
class Stream x where
readLine :: x -> IO (Result String)
readBlock :: x -> Int -> IO (Result String)
writeBlock :: x -> String -> IO (Result ())
close :: x -> IO ()
debugStream :: Stream a => String -> a -> IO (Debug a)
data ConnError
= ErrorReset
| ErrorClosed
| ErrorParse String
| ErrorMisc String
type Result a = Either ConnError a
handleSocketError :: Socket -> Exception -> IO (Result a)
bindE :: Either ConnError a -> (a -> Either ConnError b) -> Either ConnError b
myrecv :: Socket -> Int -> IO String
Streams
data Debug x Source
Allows stream logging. Refer to debugStream below.
show/hide Instances
class Stream x whereSource

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)Source
readBlock :: x -> Int -> IO (Result String)Source
writeBlock :: x -> String -> IO (Result ())Source
close :: x -> IO ()Source
show/hide Instances
debugStream :: Stream a => String -> a -> IO (Debug a)Source
Wraps a stream with logging I/O, the first argument is a filename which is opened in AppendMode.
Errors
data ConnError Source
Constructors
ErrorReset
ErrorClosed
ErrorParse String
ErrorMisc String
show/hide Instances
type Result a = Either ConnError aSource
This is the type returned by many exported network functions.
handleSocketError :: Socket -> Exception -> IO (Result a)Source
bindE :: Either ConnError a -> (a -> Either ConnError b) -> Either ConnError bSource
myrecv :: Socket -> Int -> IO StringSource
Produced by Haddock version 2.6.0