Network.Wreq.Session

The functions in this module use a Session to handle the following common needs:

• TCP connection reuse. This is important for performance when multiple requests go to a single server, particularly if TLS is being used.
• Transparent cookie management. Any cookies set by the server persist from one request to the next. (Bypass this overhead using newAPISession.)

This module is designed to be used alongside the Network.Wreq module. Typical usage will look like this:

import Network.Wreq
import qualified Network.Wreq.Session as Sess

main = do
  sess <- Sess.newSession
  Sess.get sess "http://httpbin.org/get"

We create a Session using newSession, then pass the session to subsequent functions. When talking to a REST-like service that does not use cookies, it is more efficient to use newAPISession.

Note the use of qualified import statements in the examples above, so that we can refer unambiguously to the Session-specific implementation of HTTP GET.

One Manager (possibly set with newSessionControl) is used for all session requests. The manager settings in the Options parameter for the getWith, postWith and similar functions is ignored.

Session creation

data Session

A session that spans multiple requests. This is responsible for cookie management and TCP connection reuse.

Instances

Show Session

Methods

showsPrec :: Int -> Session -> ShowS

show :: Session -> String

showList :: [Session] -> ShowS

newSession :: IO Session

Create a Session.

This session manages cookies and uses default session manager configuration.

Since: 0.5.2.0

newAPISession :: IO Session

Create a session.

This uses the default session manager settings, but does not manage cookies. It is intended for use with REST-like HTTP-based APIs, which typically do not use cookies.

Since: 0.5.2.0

withSession :: (Session -> IO a) -> IO a

Deprecated: Use newSession instead.

Create a Session, passing it to the given function. The Session will no longer be valid after that function returns.

This session manages cookies and uses default session manager configuration.

withAPISession :: (Session -> IO a) -> IO a

Deprecated: Use newAPISession instead.

Create a session.

This uses the default session manager settings, but does not manage cookies. It is intended for use with REST-like HTTP-based APIs, which typically do not use cookies.

More control-oriented session creation

newSessionControl

Arguments

:: Maybe CookieJar

If Nothing is specified, no cookie management will be performed.

-> ManagerSettings

-> IO Session

Create a session, using the given cookie jar and manager settings.

Since: 0.5.2.0

withSessionWith :: ManagerSettings -> (Session -> IO a) -> IO a

Deprecated: Use newSessionControl instead.

Create a session, using the given manager settings. This session manages cookies.

withSessionControl

Arguments

:: Maybe CookieJar

If Nothing is specified, no cookie management will be performed.

-> ManagerSettings

-> (Session -> IO a)

-> IO a

Deprecated: Use newSessionControl instead.

Create a session, using the given cookie jar and manager settings.

Get information about session state

getSessionCookieJar :: Session -> IO (Maybe CookieJar)

Extract current CookieJar from a Session

Since: 0.5.2.0

HTTP verbs

get :: Session -> String -> IO (Response ByteString)

Session-specific version of get.

post :: Postable a => Session -> String -> a -> IO (Response ByteString)

Session-specific version of post.

head_ :: Session -> String -> IO (Response ())

Session-specific version of head_.

options :: Session -> String -> IO (Response ())

Session-specific version of options.

put :: Putable a => Session -> String -> a -> IO (Response ByteString)

Session-specific version of put.

delete :: Session -> String -> IO (Response ByteString)

Session-specific version of delete.

customMethod :: String -> Session -> String -> IO (Response ByteString)

Session-specific version of customMethod.

Configurable verbs

getWith :: Options -> Session -> String -> IO (Response ByteString)

Session-specific version of getWith.

postWith :: Postable a => Options -> Session -> String -> a -> IO (Response ByteString)

Session-specific version of postWith.

headWith :: Options -> Session -> String -> IO (Response ())

Session-specific version of headWith.

optionsWith :: Options -> Session -> String -> IO (Response ())

Session-specific version of optionsWith.

putWith :: Putable a => Options -> Session -> String -> a -> IO (Response ByteString)

Session-specific version of putWith.

deleteWith :: Options -> Session -> String -> IO (Response ByteString)

Session-specific version of deleteWith.

customMethodWith :: String -> Options -> Session -> String -> IO (Response ByteString)

Session-specific version of customMethodWith.

customPayloadMethodWith :: Postable a => String -> Options -> Session -> String -> a -> IO (Response ByteString)

Session-specific version of customPayloadMethodWith.

customHistoriedMethodWith :: String -> Options -> Session -> String -> IO (HistoriedResponse ByteString)

Session-specific version of customHistoriedMethodWith.

Since: 0.5.2.0

customHistoriedPayloadMethodWith :: Postable a => String -> Options -> Session -> String -> a -> IO (HistoriedResponse ByteString)

Session-specific version of customHistoriedPayloadMethodWith.

Since: 0.5.2.0

Extending a session

seshRun :: Lens' Session (Session -> Run Body -> Run Body)