diff options
| author | Loïc Hoguin <[email protected]> | 2018-11-14 10:55:23 +0100 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-11-14 10:55:23 +0100 |
| commit | 2f502078fd0f56e3e61e58f1d57ae15f9f736ffe (patch) | |
| tree | cd80952cbe2f336a0485535ef82a8c59d49a593d /src | |
| parent | 4d0ae7e8c646d00eb868fdee11756b1770a3b976 (diff) | |
| download | ranch-2f502078fd0f56e3e61e58f1d57ae15f9f736ffe.tar.gz ranch-2f502078fd0f56e3e61e58f1d57ae15f9f736ffe.tar.bz2 ranch-2f502078fd0f56e3e61e58f1d57ae15f9f736ffe.zip | |
Document the PROXY-related functions; prepare 1.7.0
Diffstat (limited to 'src')
| -rw-r--r-- | src/ranch.erl | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/ranch.erl b/src/ranch.erl index 894f78b..814e928 100644 --- a/src/ranch.erl +++ b/src/ranch.erl @@ -257,6 +257,10 @@ handshake(Ref, Opts) -> end end. +%% Unlike handshake/2 this function always return errors because +%% the communication between the proxy and the server are expected +%% to be reliable. If there is a problem while receiving the proxy +%% header, we probably want to know about it. -spec recv_proxy_header(ref(), timeout()) -> {ok, ranch_proxy_header:proxy_info()} | {error, closed | atom()} |