HTTP-3001.1.4: A library for client-side HTTP Contents Index

Network.Browser Portability non-portable (not tested) Stability experimental Maintainer bjorn@bringert.net

Description

An HTTP/1.1 compatible wrapper for the HTTP module.

Synopsis

data BrowserState data BrowserAction a data Cookie = MkCookie { ckDomain :: String ckName :: String ckValue :: String ckPath :: Maybe String ckComment :: Maybe String ckVersion :: Maybe String } data Form = Form RequestMethod URI [FormVar] data Proxy = NoProxy | Proxy String (Maybe Authority) browse :: BrowserAction a -> IO a request :: Request -> BrowserAction (URI, Response) setAllowRedirects :: Bool -> BrowserAction () getAllowRedirects :: BrowserAction Bool data Authority = AuthBasic { auRealm :: String auUsername :: String auPassword :: String auSite :: URI } | AuthDigest { auRealm :: String auUsername :: String auPassword :: String auNonce :: String auAlgorithm :: Maybe Algorithm auDomain :: [URI] auOpaque :: Maybe String auQop :: [Qop] } getAuthorities :: BrowserAction [Authority] setAuthorities :: [Authority] -> BrowserAction () addAuthority :: Authority -> BrowserAction () getAuthorityGen :: BrowserAction (URI -> String -> IO (Maybe (String, String))) setAuthorityGen :: (URI -> String -> IO (Maybe (String, String))) -> BrowserAction () setAllowBasicAuth :: Bool -> BrowserAction () setCookieFilter :: (URI -> Cookie -> IO Bool) -> BrowserAction () defaultCookieFilter :: URI -> Cookie -> IO Bool userCookieFilter :: URI -> Cookie -> IO Bool getCookies :: BrowserAction [Cookie] setCookies :: [Cookie] -> BrowserAction () addCookie :: Cookie -> BrowserAction () setOutHandler :: (String -> IO ()) -> BrowserAction () setProxy :: Proxy -> BrowserAction () setDebugLog :: Maybe String -> BrowserAction () err :: String -> BrowserAction () ioAction :: IO a -> BrowserAction a defaultGETRequest :: URI -> Request formToRequest :: Form -> Request uriDefaultTo :: URI -> URI -> URI uriTrimHost :: URI -> URI

Documentation

data BrowserState

Instances Show BrowserState

data BrowserAction a

Instances Monad BrowserAction Functor BrowserAction

data Cookie

Constructors MkCookie ckDomain :: String ckName :: String ckValue :: String ckPath :: Maybe String ckComment :: Maybe String ckVersion :: Maybe String Instances Eq Cookie Read Cookie Show Cookie

data Form

Constructors Form RequestMethod URI [FormVar]

data Proxy

Specifies if a proxy should be used for the request. Constructors NoProxy Don't use a proxy. Proxy String (Maybe Authority) Use the proxy given. Should be of the form http://host:port, host, host:port, or http://host

browse :: BrowserAction a -> IO a

Apply a browser action to a state.

request :: Request -> BrowserAction (URI, Response)

setAllowRedirects :: Bool -> BrowserAction ()

getAllowRedirects :: BrowserAction Bool

data Authority

Constructors AuthBasic auRealm :: String auUsername :: String auPassword :: String auSite :: URI AuthDigest auRealm :: String auUsername :: String auPassword :: String auNonce :: String auAlgorithm :: Maybe Algorithm auDomain :: [URI] auOpaque :: Maybe String auQop :: [Qop]

getAuthorities :: BrowserAction [Authority]

Interacting with browser state:

setAuthorities :: [Authority] -> BrowserAction ()

addAuthority :: Authority -> BrowserAction ()

getAuthorityGen :: BrowserAction (URI -> String -> IO (Maybe (String, String)))

setAuthorityGen :: (URI -> String -> IO (Maybe (String, String))) -> BrowserAction ()

setAllowBasicAuth :: Bool -> BrowserAction ()

setCookieFilter :: (URI -> Cookie -> IO Bool) -> BrowserAction ()

defaultCookieFilter :: URI -> Cookie -> IO Bool

userCookieFilter :: URI -> Cookie -> IO Bool

getCookies :: BrowserAction [Cookie]

setCookies :: [Cookie] -> BrowserAction ()

addCookie :: Cookie -> BrowserAction ()

Adds a cookie to the browser state, removing duplicates.

setOutHandler :: (String -> IO ()) -> BrowserAction ()

setProxy :: Proxy -> BrowserAction ()

setDebugLog :: Maybe String -> BrowserAction ()

err :: String -> BrowserAction ()

ioAction :: IO a -> BrowserAction a

Do an io action

defaultGETRequest :: URI -> Request

formToRequest :: Form -> Request

uriDefaultTo :: URI -> URI -> URI

Returns a URI that is consistent with the first argument uri when read in the context of a second. If second argument is not sufficient context for determining a full URI then anarchy reins.

uriTrimHost :: URI -> URI

Produced by Haddock version 2.3.0