Minor doc improvements

This commit is contained in:
Michael Snoyman 2014-12-30 05:56:01 +02:00
parent 4cfcd14f74
commit 1977a1a7ce
2 changed files with 13 additions and 0 deletions

View File

@ -1,3 +1,10 @@
## 3.0.5
Support for PROXY protocol, such as used by Amazon ELB TCP. This is useful
since, for example, Amazon ELB HTTP does *not* have support for Websockets.
More information on the protocol [is available from
Amazon](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol).
## 3.0.4
Added `setFork`.

View File

@ -246,6 +246,8 @@ setFork :: (((forall a. IO a -> IO a) -> IO ()) -> IO ()) -> Settings -> Setting
setFork fork' s = s { settingsFork = fork' }
-- | Do not use the PROXY protocol.
--
-- Since 3.0.5
setProxyProtocolNone :: Settings -> Settings
setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
@ -260,6 +262,8 @@ setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
--
-- Only the human-readable header format (version 1) is supported. The binary
-- header format (version 2) is /not/ supported.
--
-- Since 3.0.5
setProxyProtocolRequired :: Settings -> Settings
setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
@ -274,5 +278,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
-- such as if a load balancer health check uses regular
-- HTTP without the PROXY header, but proxied
-- connections /do/ include the PROXY header.
--
-- Since 3.0.5
setProxyProtocolOptional :: Settings -> Settings
setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }