SRC="haddock-util.js" TYPE="text/javascript"> TYPE="text/javascript">window.onload = function () {setSynopsis("mini_Network-Stream.html")};

Network.Stream

HTTP-300100

Network.Stream

Portability	non-portable (not tested)
Stability	experimental
Maintainer	bjorn@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)

| 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

data Debug x

Allows stream logging. Refer to debugStream below.

show/hide Instances

Stream x => Stream (Debug x)

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

show/hide Instances

Stream Connection

Stream x => Stream (Debug x)

debugStream :: Stream a => String -> a -> IO (Debug a)

Wraps a stream with logging I/O, the first argument is a filename which is opened in AppendMode.

data ConnError

Constructors

ErrorReset

ErrorClosed

ErrorParse String

ErrorMisc String

show/hide Instances

type Result a = Either ConnError a

This is the type returned by many exported network functions.

handleSocketError :: Socket -> Exception -> IO (Result a)

bindE :: Either ConnError a -> (a -> Either ConnError b) -> Either ConnError b

myrecv :: Socket -> Int -> IO String

Produced by Haddock version 2.6.0