Documentation

BrowserState is the (large) record type tracking the current settings of the browser.

BrowserAction is the IO monad, but carrying along a BrowserState.

HTTP proxies (or not) are represented via Proxy, specifying if a proxy should be used for the request (see setProxy)

browse act is the toplevel action to perform a BrowserAction. Example use: browse (request (getRequest yourURL)).

request httpRequest tries to submit the Request httpRequest to some HTTP server (possibly going via a proxy, see setProxy.) Upon successful delivery, the URL where the response was fetched from is returned along with the Response itself.

getBrowserState returns the current browser config. Useful for restoring state across BrowserActions.

withBrowserAction st act performs act with BrowserState st.

setAllowRedirects onOff toggles the willingness to follow redirects (HTTP responses with 3xx status codes).

getAllowRedirects returns current setting of the do-chase-redirects flag.

setMaxRedirects maxCount sets the maximum number of forwarding hops we are willing to jump through. A no-op if the count is negative; if zero, the max is set to whatever default applies. Notice that setting the max redirects count does not enable following of redirects itself; use setAllowRedirects to do so.

getMaxRedirects returns the current setting for the max-redirect count. If Nothing, the Network.Browser's default is used.

Authority specifies the HTTP Authentication method to use for a given domain/realm; Basic or Digest.

getAuthorities return the current set of Authoritys known to the browser.

Algorithm controls the digest algorithm to, MD5 or MD5Session.

getAuthorityGen returns the current authority generator

setAuthorityGen genAct sets the auth generator to genAct.

setAllowBasicAuth onOff enables/disables HTTP Basic Authentication.

setMaxErrorRetries mbMax sets the maximum number of attempts at transmitting a request. If Nothing, rever to default max.

getMaxErrorRetries returns the current max number of error retries.

setMaxPoolSize maxCount sets the maximum size of the connection pool that is used to cache connections between requests

getMaxPoolSize gets the maximum size of the connection pool that is used to cache connections between requests. If Nothing, the Network.Browser's default is used.

setMaxAuthAttempts mbMax sets the maximum number of authentication attempts to do. If Nothing, revert to default max.

getMaxAuthAttempts returns the current max auth attempts. If Nothing, the browser's default is used.

setCookieFilter fn sets the cookie acceptance filter to fn.

getCookieFilter returns the current cookie acceptance filter.

defaultCookieFilter is the initial cookie acceptance filter. It welcomes them all into the store :-)

userCookieFilter is a handy acceptance filter, asking the user if he/she is willing to accept an incoming cookie before adding it to the store.

Cookie is the Haskell representation of HTTP cookie values. See its relevant specs for authoritative details.

getCookies returns the current set of cookies known to the browser.

setCookies cookies replaces the set of cookies known to the browser to cookies. Useful when wanting to restore cookies used across browse invocations.

addCookie c adds a cookie to the browser state, removing duplicates.

setErrHandler sets the IO action to call when the browser reports running errors. To disable any such, set it to const (return ()).

setOutHandler sets the IO action to call when the browser chatters info on its running. To disable any such, set it to const (return ()).

setEventHandler onBrowserEvent configures event handling. If onBrowserEvent is Nothing, event handling is turned off; setting it to Just onEv causes the onEv IO action to be notified of browser events during the processing of a request by the Browser pipeline.

BrowserEvent is the event record type that a user-defined handler, set via setEventHandler, will be passed. It indicates various state changes encountered in the processing of a given RequestID, along with timestamps at which they occurred.

BrowserEventType is the enumerated list of events that the browser internals will report to a user-defined event handler.

setProxy p will disable proxy usage if p is NoProxy. If p is Proxy proxyURL mbAuth, then proxyURL is interpreted as the URL of the proxy to use, possibly authenticating via Authority information in mbAuth.

getProxy returns the current proxy settings. If the auto-proxy flag is set to True, getProxy will perform the necessary

setCheckForProxy flg sets the one-time check for proxy flag to flg. If True, the session will try to determine the proxy server is locally configured. See fetchProxy for details of how this done.

getCheckForProxy returns the current check-proxy setting. Notice that this may not be equal to True if the session has set it to that via setCheckForProxy and subsequently performed some HTTP protocol interactions. i.e., the flag return represents whether a proxy will be checked for again before any future protocol interactions.

setDebugLog mbFile turns off debug logging iff mbFile is Nothing. If set to Just fStem, logs of browser activity is appended to files of the form fStem-url-authority, i.e., fStem is just the prefix for a set of log files, one per host/authority.

getUserAgent returns the current User-Agent: default string.

setUserAgent ua sets the current User-Agent: string to ua. It will be used if no explicit user agent header is found in subsequent requests.

A common form of user agent string is "name/version (details)". For example "cabal-install/0.10.2 (HTTP 4000.1.2)". Including the version of this HTTP package can be helpful if you ever need to track down HTTP compatibility quirks. This version is available via httpPackageVersion. For more info see http://en.wikipedia.org/wiki/User_agent.

Lifts an IO action into the BrowserAction monad.

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