1977a1a · typeable/wai

git.iko.soy/typeable/wai

Minor doc improvements

commit1977a1a7ce76af0866be525405cdcf23ab3a222f authorMichael Snoyman <michael@snoyman.com> dateTue 30 Dec 2014, 05:56 (12 years ago) parent4cfcd14

2 files changed+13

unifiedsplit

warp/ChangeLog.md+7

@@ -1,3 +1,10 @@

1+## 3.0.5

3+Support for PROXY protocol, such as used by Amazon ELB TCP. This is useful

4+since, for example, Amazon ELB HTTP does *not* have support for Websockets.

5+More information on the protocol [is available from

6+Amazon](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol).

18## 3.0.4

310Added `setFork`.

warp/Network/Wai/Handler/Warp.hs+6

@@ -246,6 +246,8 @@ setFork :: (((forall a. IO a -> IO a) -> IO ()) -> IO ()) -> Settings -> Setting

246246setFork fork' s = s { settingsFork = fork' }

247247

248248-- | Do not use the PROXY protocol.

249+--

250+-- Since 3.0.5

249251setProxyProtocolNone :: Settings -> Settings

250252setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }

251253

@@ -260,6 +262,8 @@ setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }

260262--

261263-- Only the human-readable header format (version 1) is supported. The binary

262264-- header format (version 2) is /not/ supported.

265+--

266+-- Since 3.0.5

263267setProxyProtocolRequired :: Settings -> Settings

264268setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }

265269

@@ -274,5 +278,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }

274278-- such as if a load balancer health check uses regular

275279-- HTTP without the PROXY header, but proxied

276280-- connections /do/ include the PROXY header.

281+--

282+-- Since 3.0.5

277283setProxyProtocolOptional :: Settings -> Settings

278284setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }