/usr/share/doc/libghc-http-client-doc/html/src/Network-HTTP-Client.html is in libghc-http-client-doc 0.4.26.2-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Network/HTTP/Client.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE DeriveFunctor #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE DeriveTraversable #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE DeriveFoldable #-}</span>
<a name="line-4"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-5"></a><span class='hs-comment'>{-# LANGUAGE DeriveGeneric #-}</span>
<a name="line-6"></a><span class='hs-comment'>-- | This is the main entry point for using http-client. Used by itself, this</span>
<a name="line-7"></a><span class='hs-comment'>-- module provides low-level access for streaming request and response bodies,</span>
<a name="line-8"></a><span class='hs-comment'>-- and only non-secure HTTP connections. Helper packages such as http-conduit</span>
<a name="line-9"></a><span class='hs-comment'>-- provided higher level streaming approaches, while other helper packages like</span>
<a name="line-10"></a><span class='hs-comment'>-- http-client-tls provide secure connections.</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- There are three core components to be understood here: requests, responses,</span>
<a name="line-13"></a><span class='hs-comment'>-- and managers. A 'Manager' keeps track of open connections to various hosts,</span>
<a name="line-14"></a><span class='hs-comment'>-- and when requested, will provide either an existing open connection or</span>
<a name="line-15"></a><span class='hs-comment'>-- create a new connection on demand. A 'Manager' also automatically reaps</span>
<a name="line-16"></a><span class='hs-comment'>-- connections which have been unused for a certain period of time. A 'Manager'</span>
<a name="line-17"></a><span class='hs-comment'>-- allows for more efficient HTTP usage by allowing for keep-alive connections.</span>
<a name="line-18"></a><span class='hs-comment'>-- Secure HTTP connections can be allowed by modifying the settings used for</span>
<a name="line-19"></a><span class='hs-comment'>-- creating a manager. The simplest way to create a 'Manager' is with:</span>
<a name="line-20"></a><span class='hs-comment'>--</span>
<a name="line-21"></a><span class='hs-comment'>-- @</span>
<a name="line-22"></a><span class='hs-comment'>-- 'newManager' 'defaultManagerSettings'</span>
<a name="line-23"></a><span class='hs-comment'>-- @</span>
<a name="line-24"></a><span class='hs-comment'>--</span>
<a name="line-25"></a><span class='hs-comment'>-- While generally speaking it is a good idea to share a single 'Manager'</span>
<a name="line-26"></a><span class='hs-comment'>-- throughout your application, there are cases where it makes more sense to</span>
<a name="line-27"></a><span class='hs-comment'>-- create and destroy 'Manager's more frequently. As an example, if you have an</span>
<a name="line-28"></a><span class='hs-comment'>-- application which will make a large number of requests to different hosts,</span>
<a name="line-29"></a><span class='hs-comment'>-- and will never make more than one connection to a single host, then sharing</span>
<a name="line-30"></a><span class='hs-comment'>-- a 'Manager' will result in idle connections being kept open longer than</span>
<a name="line-31"></a><span class='hs-comment'>-- necessary. In such a situation, it makes sense to use 'withManager' around</span>
<a name="line-32"></a><span class='hs-comment'>-- each new request, to avoid running out of file descriptors. (Note that the</span>
<a name="line-33"></a><span class='hs-comment'>-- 'managerIdleConnectionCount' setting mitigates the risk of leaking too many</span>
<a name="line-34"></a><span class='hs-comment'>-- file descriptors.)</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><span class='hs-comment'>-- The next core component is a 'Request', which represents a single HTTP</span>
<a name="line-37"></a><span class='hs-comment'>-- request to be sent to a specific server. 'Request's allow for many settings</span>
<a name="line-38"></a><span class='hs-comment'>-- to control exact how they function, but usually the simplest approach for</span>
<a name="line-39"></a><span class='hs-comment'>-- creating a 'Request' is to use 'parseUrl'.</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- Finally, a 'Response' is the result of sending a single 'Request' to a</span>
<a name="line-42"></a><span class='hs-comment'>-- server, over a connection which was acquired from a 'Manager'. Note that you</span>
<a name="line-43"></a><span class='hs-comment'>-- must close the response when you're done with it to ensure that the</span>
<a name="line-44"></a><span class='hs-comment'>-- connection is recycled to the 'Manager' to either be used by another</span>
<a name="line-45"></a><span class='hs-comment'>-- request, or to be reaped. Usage of 'withResponse' will ensure that this</span>
<a name="line-46"></a><span class='hs-comment'>-- happens automatically.</span>
<a name="line-47"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><span class='hs-comment'>-- Helper packages may provide replacements for various recommendations listed</span>
<a name="line-49"></a><span class='hs-comment'>-- above. For example, if using http-client-tls, instead of using</span>
<a name="line-50"></a><span class='hs-comment'>-- 'defaultManagerSettings', you would want to use 'tlsManagerSettings'. Be</span>
<a name="line-51"></a><span class='hs-comment'>-- sure to read the relevant helper library documentation for more information.</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- A note on exceptions: for the most part, all actions that perform I/O should</span>
<a name="line-54"></a><span class='hs-comment'>-- be assumed to throw an 'HttpException' in the event of some problem, and all</span>
<a name="line-55"></a><span class='hs-comment'>-- pure functions will be total. For example, 'withResponse', 'httpLbs', and</span>
<a name="line-56"></a><span class='hs-comment'>-- 'BodyReader' can all throw exceptions. Functions like 'responseStatus' and</span>
<a name="line-57"></a><span class='hs-comment'>-- 'applyBasicAuth' are guaranteed to be total (or there\'s a bug in the</span>
<a name="line-58"></a><span class='hs-comment'>-- library).</span>
<a name="line-59"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><span class='hs-comment'>-- One thing to be cautioned about: the type of 'parseUrl' allows it to work in</span>
<a name="line-61"></a><span class='hs-comment'>-- different monads. If used in the 'IO' monad, it will throw an exception in</span>
<a name="line-62"></a><span class='hs-comment'>-- the case of an invalid URI. In addition, if you leverage the @IsString@</span>
<a name="line-63"></a><span class='hs-comment'>-- instance of the 'Request' value via @OverloadedStrings@, an invalid URI will</span>
<a name="line-64"></a><span class='hs-comment'>-- result in a partial value. Caveat emptor!</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-comment'>-- Non-2xx responses: the default behavior of all functions in http-client is</span>
<a name="line-67"></a><span class='hs-comment'>-- to automatically perform up to 10 redirects (response codes 301, 302, 303,</span>
<a name="line-68"></a><span class='hs-comment'>-- and 307), and to throw a 'StatusCodeException' on all responses whose status</span>
<a name="line-69"></a><span class='hs-comment'>-- are not in the 2xx range. These behaviors can be overridden by the</span>
<a name="line-70"></a><span class='hs-comment'>-- 'redirectCount' and 'checkStatus' settings on a request, respectively.</span>
<a name="line-71"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span>
<a name="line-72"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- $example1</span>
<a name="line-73"></a>
<a name="line-74"></a> <span class='hs-comment'>-- * Performing requests</span>
<a name="line-75"></a> <span class='hs-varid'>withResponse</span>
<a name="line-76"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>httpLbs</span>
<a name="line-77"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>httpNoBody</span>
<a name="line-78"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseOpen</span>
<a name="line-79"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseClose</span>
<a name="line-80"></a> <span class='hs-comment'>-- ** Tracking redirect history</span>
<a name="line-81"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>withResponseHistory</span>
<a name="line-82"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseOpenHistory</span>
<a name="line-83"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HistoriedResponse</span>
<a name="line-84"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrRedirects</span>
<a name="line-85"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalRequest</span>
<a name="line-86"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalResponse</span>
<a name="line-87"></a> <span class='hs-comment'>-- * Connection manager</span>
<a name="line-88"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Manager</span>
<a name="line-89"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>newManager</span>
<a name="line-90"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>closeManager</span>
<a name="line-91"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>withManager</span>
<a name="line-92"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HasHttpManager</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-93"></a> <span class='hs-comment'>-- ** Connection manager settings</span>
<a name="line-94"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ManagerSettings</span>
<a name="line-95"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultManagerSettings</span>
<a name="line-96"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerConnCount</span>
<a name="line-97"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerRawConnection</span>
<a name="line-98"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerTlsConnection</span>
<a name="line-99"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerResponseTimeout</span>
<a name="line-100"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerRetryableException</span>
<a name="line-101"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerWrapIOException</span>
<a name="line-102"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerIdleConnectionCount</span>
<a name="line-103"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerModifyRequest</span>
<a name="line-104"></a> <span class='hs-comment'>-- *** Manager proxy settings</span>
<a name="line-105"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerSetProxy</span>
<a name="line-106"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerSetInsecureProxy</span>
<a name="line-107"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>managerSetSecureProxy</span>
<a name="line-108"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>ProxyOverride</span>
<a name="line-109"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>proxyFromRequest</span>
<a name="line-110"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>noProxy</span>
<a name="line-111"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>useProxy</span>
<a name="line-112"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>proxyEnvironment</span>
<a name="line-113"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>proxyEnvironmentNamed</span>
<a name="line-114"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>defaultProxy</span>
<a name="line-115"></a> <span class='hs-comment'>-- *** Helpers</span>
<a name="line-116"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>rawConnectionModifySocket</span>
<a name="line-117"></a> <span class='hs-comment'>-- * Request</span>
<a name="line-118"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>parseUrl</span>
<a name="line-119"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>applyBasicAuth</span>
<a name="line-120"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>urlEncodedBody</span>
<a name="line-121"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>getUri</span>
<a name="line-122"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>setQueryString</span>
<a name="line-123"></a> <span class='hs-comment'>-- ** Request type and fields</span>
<a name="line-124"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Request</span>
<a name="line-125"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>method</span>
<a name="line-126"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>secure</span>
<a name="line-127"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>host</span>
<a name="line-128"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>port</span>
<a name="line-129"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>path</span>
<a name="line-130"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>queryString</span>
<a name="line-131"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>requestHeaders</span>
<a name="line-132"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>requestBody</span>
<a name="line-133"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>proxy</span>
<a name="line-134"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>applyBasicProxyAuth</span>
<a name="line-135"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>decompress</span>
<a name="line-136"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>redirectCount</span>
<a name="line-137"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>checkStatus</span>
<a name="line-138"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseTimeout</span>
<a name="line-139"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>cookieJar</span>
<a name="line-140"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>requestVersion</span>
<a name="line-141"></a> <span class='hs-comment'>-- ** Request body</span>
<a name="line-142"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>RequestBody</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-143"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Popper</span>
<a name="line-144"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>NeedsPopper</span>
<a name="line-145"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>GivesPopper</span>
<a name="line-146"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>streamFile</span>
<a name="line-147"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>observedStreamFile</span>
<a name="line-148"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>StreamFileStatus</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-149"></a> <span class='hs-comment'>-- * Response</span>
<a name="line-150"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Response</span>
<a name="line-151"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseStatus</span>
<a name="line-152"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseVersion</span>
<a name="line-153"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseHeaders</span>
<a name="line-154"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseBody</span>
<a name="line-155"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>responseCookieJar</span>
<a name="line-156"></a> <span class='hs-comment'>-- ** Response body</span>
<a name="line-157"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>BodyReader</span>
<a name="line-158"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>brRead</span>
<a name="line-159"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>brReadSome</span>
<a name="line-160"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>brConsume</span>
<a name="line-161"></a> <span class='hs-comment'>-- * Misc</span>
<a name="line-162"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HttpException</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-163"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Cookie</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-164"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>CookieJar</span>
<a name="line-165"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Proxy</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-166"></a> <span class='hs-comment'>-- * Cookies</span>
<a name="line-167"></a> <span class='hs-layout'>,</span> <span class='hs-keyword'>module</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Cookies</span>
<a name="line-168"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-169"></a>
<a name="line-170"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Body</span>
<a name="line-171"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Cookies</span>
<a name="line-172"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span>
<a name="line-173"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Manager</span>
<a name="line-174"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Request</span>
<a name="line-175"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Response</span>
<a name="line-176"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Client</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-177"></a>
<a name="line-178"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Text</span> <span class='hs-layout'>(</span><span class='hs-conid'>Text</span><span class='hs-layout'>)</span>
<a name="line-179"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>IORef</span> <span class='hs-layout'>(</span><span class='hs-varid'>newIORef</span><span class='hs-layout'>,</span> <span class='hs-varid'>writeIORef</span><span class='hs-layout'>,</span> <span class='hs-varid'>readIORef</span><span class='hs-layout'>,</span> <span class='hs-varid'>modifyIORef</span><span class='hs-layout'>)</span>
<a name="line-180"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>L</span>
<a name="line-181"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Foldable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Foldable</span><span class='hs-layout'>)</span>
<a name="line-182"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Traversable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Traversable</span><span class='hs-layout'>)</span>
<a name="line-183"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>HTTP</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-varid'>statusCode</span><span class='hs-layout'>)</span>
<a name="line-184"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span> <span class='hs-layout'>(</span><span class='hs-conid'>Generic</span><span class='hs-layout'>)</span>
<a name="line-185"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-186"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-layout'>(</span><span class='hs-varid'>bracket</span><span class='hs-layout'>)</span>
<a name="line-187"></a>
<a name="line-188"></a><a name="HistoriedResponse"></a><span class='hs-comment'>-- | A datatype holding information on redirected requests and the final response.</span>
<a name="line-189"></a><a name="HistoriedResponse"></a><span class='hs-comment'>--</span>
<a name="line-190"></a><a name="HistoriedResponse"></a><span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-191"></a><a name="HistoriedResponse"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>HistoriedResponse</span> <span class='hs-varid'>body</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>HistoriedResponse</span>
<a name="line-192"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>hrRedirects</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Request</span><span class='hs-layout'>,</span> <span class='hs-conid'>Response</span> <span class='hs-conid'>L</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-193"></a> <span class='hs-comment'>-- ^ Requests which resulted in a redirect, together with their responses.</span>
<a name="line-194"></a> <span class='hs-comment'>-- The response contains the first 1024 bytes of the body.</span>
<a name="line-195"></a> <span class='hs-comment'>--</span>
<a name="line-196"></a> <span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-197"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalRequest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span>
<a name="line-198"></a> <span class='hs-comment'>-- ^ The final request performed.</span>
<a name="line-199"></a> <span class='hs-comment'>--</span>
<a name="line-200"></a> <span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-201"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalResponse</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Response</span> <span class='hs-varid'>body</span>
<a name="line-202"></a> <span class='hs-comment'>-- ^ The response from the final request.</span>
<a name="line-203"></a> <span class='hs-comment'>--</span>
<a name="line-204"></a> <span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-205"></a> <span class='hs-layout'>}</span>
<a name="line-206"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Functor</span><span class='hs-layout'>,</span> <span class='hs-conid'>Traversable</span><span class='hs-layout'>,</span> <span class='hs-conid'>Foldable</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>,</span> <span class='hs-conid'>Generic</span><span class='hs-layout'>)</span>
<a name="line-207"></a>
<a name="line-208"></a><a name="responseOpenHistory"></a><span class='hs-comment'>-- | A variant of @responseOpen@ which keeps a history of all redirects</span>
<a name="line-209"></a><span class='hs-comment'>-- performed in the interim, together with the first 1024 bytes of their</span>
<a name="line-210"></a><span class='hs-comment'>-- response bodies.</span>
<a name="line-211"></a><span class='hs-comment'>--</span>
<a name="line-212"></a><span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-213"></a><span class='hs-definition'>responseOpenHistory</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Manager</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>HistoriedResponse</span> <span class='hs-conid'>BodyReader</span><span class='hs-layout'>)</span>
<a name="line-214"></a><span class='hs-definition'>responseOpenHistory</span> <span class='hs-varid'>req0</span> <span class='hs-varid'>man</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-215"></a> <span class='hs-varid'>reqRef</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newIORef</span> <span class='hs-varid'>req0</span>
<a name="line-216"></a> <span class='hs-varid'>historyRef</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newIORef</span> <span class='hs-varid'>id</span>
<a name="line-217"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>go</span> <span class='hs-varid'>req</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-218"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>httpRaw</span> <span class='hs-varid'>req</span> <span class='hs-varid'>man</span>
<a name="line-219"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>getRedirectedRequest</span>
<a name="line-220"></a> <span class='hs-varid'>req</span>
<a name="line-221"></a> <span class='hs-layout'>(</span><span class='hs-varid'>responseHeaders</span> <span class='hs-varid'>res</span><span class='hs-layout'>)</span>
<a name="line-222"></a> <span class='hs-layout'>(</span><span class='hs-varid'>responseCookieJar</span> <span class='hs-varid'>res</span><span class='hs-layout'>)</span>
<a name="line-223"></a> <span class='hs-layout'>(</span><span class='hs-varid'>statusCode</span> <span class='hs-varop'>$</span> <span class='hs-varid'>responseStatus</span> <span class='hs-varid'>res</span><span class='hs-layout'>)</span> <span class='hs-keyword'>of</span>
<a name="line-224"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>res</span><span class='hs-layout'>,</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>)</span>
<a name="line-225"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>req'</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-226"></a> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>reqRef</span> <span class='hs-varid'>req'</span>
<a name="line-227"></a> <span class='hs-varid'>body</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>brReadSome</span> <span class='hs-layout'>(</span><span class='hs-varid'>responseBody</span> <span class='hs-varid'>res</span><span class='hs-layout'>)</span> <span class='hs-num'>1024</span>
<a name="line-228"></a> <span class='hs-varid'>modifyIORef</span> <span class='hs-varid'>historyRef</span> <span class='hs-layout'>(</span><span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>req</span><span class='hs-layout'>,</span> <span class='hs-varid'>res</span> <span class='hs-layout'>{</span> <span class='hs-varid'>responseBody</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>body</span> <span class='hs-layout'>}</span><span class='hs-layout'>)</span><span class='hs-conop'>:</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-229"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>res</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>req'</span><span class='hs-layout'>)</span>
<a name="line-230"></a> <span class='hs-varid'>res</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>httpRedirect</span> <span class='hs-layout'>(</span><span class='hs-varid'>redirectCount</span> <span class='hs-varid'>req0</span><span class='hs-layout'>)</span> <span class='hs-varid'>go</span> <span class='hs-varid'>req0</span>
<a name="line-231"></a> <span class='hs-varid'>reqFinal</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>reqRef</span>
<a name="line-232"></a> <span class='hs-varid'>history</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>historyRef</span>
<a name="line-233"></a> <span class='hs-varid'>return</span> <span class='hs-conid'>HistoriedResponse</span>
<a name="line-234"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>hrRedirects</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>history</span> <span class='hs-conid'>[]</span>
<a name="line-235"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalRequest</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>reqFinal</span>
<a name="line-236"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>hrFinalResponse</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>res</span>
<a name="line-237"></a> <span class='hs-layout'>}</span>
<a name="line-238"></a>
<a name="line-239"></a><a name="withResponseHistory"></a><span class='hs-comment'>-- | A variant of @withResponse@ which keeps a history of all redirects</span>
<a name="line-240"></a><span class='hs-comment'>-- performed in the interim, together with the first 1024 bytes of their</span>
<a name="line-241"></a><span class='hs-comment'>-- response bodies.</span>
<a name="line-242"></a><span class='hs-comment'>--</span>
<a name="line-243"></a><span class='hs-comment'>-- Since 0.4.1</span>
<a name="line-244"></a><span class='hs-definition'>withResponseHistory</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span>
<a name="line-245"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Manager</span>
<a name="line-246"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>HistoriedResponse</span> <span class='hs-conid'>BodyReader</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-247"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-248"></a><span class='hs-definition'>withResponseHistory</span> <span class='hs-varid'>req</span> <span class='hs-varid'>man</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>bracket</span>
<a name="line-249"></a> <span class='hs-layout'>(</span><span class='hs-varid'>responseOpenHistory</span> <span class='hs-varid'>req</span> <span class='hs-varid'>man</span><span class='hs-layout'>)</span>
<a name="line-250"></a> <span class='hs-layout'>(</span><span class='hs-varid'>responseClose</span> <span class='hs-varop'>.</span> <span class='hs-varid'>hrFinalResponse</span><span class='hs-layout'>)</span>
<a name="line-251"></a>
<a name="line-252"></a><a name="managerSetInsecureProxy"></a><span class='hs-comment'>-- | Set the proxy override value, only for HTTP (insecure) connections.</span>
<a name="line-253"></a><span class='hs-comment'>--</span>
<a name="line-254"></a><span class='hs-comment'>-- Since 0.4.7</span>
<a name="line-255"></a><span class='hs-definition'>managerSetInsecureProxy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ProxyOverride</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span>
<a name="line-256"></a><span class='hs-definition'>managerSetInsecureProxy</span> <span class='hs-varid'>po</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>m</span> <span class='hs-layout'>{</span> <span class='hs-varid'>managerProxyInsecure</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>po</span> <span class='hs-layout'>}</span>
<a name="line-257"></a>
<a name="line-258"></a><a name="managerSetSecureProxy"></a><span class='hs-comment'>-- | Set the proxy override value, only for HTTPS (secure) connections.</span>
<a name="line-259"></a><span class='hs-comment'>--</span>
<a name="line-260"></a><span class='hs-comment'>-- Since 0.4.7</span>
<a name="line-261"></a><span class='hs-definition'>managerSetSecureProxy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ProxyOverride</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span>
<a name="line-262"></a><span class='hs-definition'>managerSetSecureProxy</span> <span class='hs-varid'>po</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>m</span> <span class='hs-layout'>{</span> <span class='hs-varid'>managerProxySecure</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>po</span> <span class='hs-layout'>}</span>
<a name="line-263"></a>
<a name="line-264"></a><a name="managerSetProxy"></a><span class='hs-comment'>-- | Set the proxy override value, for both HTTP (insecure) and HTTPS</span>
<a name="line-265"></a><span class='hs-comment'>-- (insecure) connections.</span>
<a name="line-266"></a><span class='hs-comment'>--</span>
<a name="line-267"></a><span class='hs-comment'>-- Since 0.4.7</span>
<a name="line-268"></a><span class='hs-definition'>managerSetProxy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ProxyOverride</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManagerSettings</span>
<a name="line-269"></a><span class='hs-definition'>managerSetProxy</span> <span class='hs-varid'>po</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>managerSetInsecureProxy</span> <span class='hs-varid'>po</span> <span class='hs-varop'>.</span> <span class='hs-varid'>managerSetSecureProxy</span> <span class='hs-varid'>po</span>
<a name="line-270"></a>
<a name="line-271"></a>
<a name="line-272"></a>
<a name="line-273"></a><span class='hs-comment'>-- $example1</span>
<a name="line-274"></a><span class='hs-comment'>-- = Example Usage</span>
<a name="line-275"></a><span class='hs-comment'>--</span>
<a name="line-276"></a><span class='hs-comment'>-- === Making a GET request</span>
<a name="line-277"></a><span class='hs-comment'>--</span>
<a name="line-278"></a><span class='hs-comment'>-- > import Network.HTTP.Client</span>
<a name="line-279"></a><span class='hs-comment'>-- > import Network.HTTP.Types.Status (statusCode)</span>
<a name="line-280"></a><span class='hs-comment'>-- ></span>
<a name="line-281"></a><span class='hs-comment'>-- > main :: IO ()</span>
<a name="line-282"></a><span class='hs-comment'>-- > main = do</span>
<a name="line-283"></a><span class='hs-comment'>-- > manager <- newManager defaultManagerSettings</span>
<a name="line-284"></a><span class='hs-comment'>-- ></span>
<a name="line-285"></a><span class='hs-comment'>-- > request <- parseUrl "<a href="http://httpbin.org/post">http://httpbin.org/post</a>"</span>
<a name="line-286"></a><span class='hs-comment'>-- > response <- httpLbs request manager</span>
<a name="line-287"></a><span class='hs-comment'>-- ></span>
<a name="line-288"></a><span class='hs-comment'>-- > putStrLn $ "The status code was: " ++ (show $ statusCode $ responseStatus response)</span>
<a name="line-289"></a><span class='hs-comment'>-- > print $ responseBody response</span>
<a name="line-290"></a><span class='hs-comment'>--</span>
<a name="line-291"></a><span class='hs-comment'>--</span>
<a name="line-292"></a><span class='hs-comment'>-- === Posting JSON to a server</span>
<a name="line-293"></a><span class='hs-comment'>--</span>
<a name="line-294"></a><span class='hs-comment'>-- > {-# LANGUAGE OverloadedStrings #-}</span>
<a name="line-295"></a><span class='hs-comment'>-- > import Network.HTTP.Client</span>
<a name="line-296"></a><span class='hs-comment'>-- > import Network.HTTP.Types.Status (statusCode)</span>
<a name="line-297"></a><span class='hs-comment'>-- > import Data.Aeson (object, (.=), encode)</span>
<a name="line-298"></a><span class='hs-comment'>-- ></span>
<a name="line-299"></a><span class='hs-comment'>-- > main :: IO ()</span>
<a name="line-300"></a><span class='hs-comment'>-- > main = do</span>
<a name="line-301"></a><span class='hs-comment'>-- > manager <- newManager defaultManagerSettings</span>
<a name="line-302"></a><span class='hs-comment'>-- ></span>
<a name="line-303"></a><span class='hs-comment'>-- > -- Create the request</span>
<a name="line-304"></a><span class='hs-comment'>-- > let requestObject = object ["name" .= "Michael", "age" .= 30]</span>
<a name="line-305"></a><span class='hs-comment'>-- > initialRequest <- parseUrl "<a href="http://httpbin.org/post">http://httpbin.org/post</a>"</span>
<a name="line-306"></a><span class='hs-comment'>-- > let request = initialRequest { method = "POST", requestBody = RequestBodyLBS $ encode requestObject }</span>
<a name="line-307"></a><span class='hs-comment'>-- ></span>
<a name="line-308"></a><span class='hs-comment'>-- > response <- httpLbs request manager</span>
<a name="line-309"></a><span class='hs-comment'>-- > putStrLn $ "The status code was: " ++ (show $ statusCode $ responseStatus response)</span>
<a name="line-310"></a><span class='hs-comment'>-- > print $ responseBody response</span>
<a name="line-311"></a><span class='hs-comment'>--</span>
</pre></body>
</html>
|