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 /doc/src/manual/ranch_proxy_header.header.asciidoc | |
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 'doc/src/manual/ranch_proxy_header.header.asciidoc')
-rw-r--r-- | doc/src/manual/ranch_proxy_header.header.asciidoc | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/src/manual/ranch_proxy_header.header.asciidoc b/doc/src/manual/ranch_proxy_header.header.asciidoc new file mode 100644 index 0000000..4dc5044 --- /dev/null +++ b/doc/src/manual/ranch_proxy_header.header.asciidoc @@ -0,0 +1,75 @@ += ranch_proxy_header:header(3) + +== Name + +ranch_proxy_header:header - Build a PROXY protocol header + +== Description + +[source,erlang] +---- +header(ProxyInfo) -> header(ProxyInfo, #{}) +header(ProxyInfo, BuildOpts) -> iodata() + +ProxyInfo :: ranch_proxy_header:proxy_info() +BuildOpts :: #{ + checksum => crc32, + padding => pos_integer() %% >= 3 +} +---- + +Build a PROXY protocol header. + +== Arguments + +ProxyInfo:: + +The proxy information to encode. + +BuildOpts:: + +Options to control whether to add a checksum or padding +should be included in the encoded PROXY protocol header. + +== Return value + +The PROXY protocol header is returned. + +== Changelog + +* *1.7*: Function introduced. + +== Examples + +.Build a PROXY protocol header +[source,erlang] +---- +ProxyInfo = #{ + version => 2, + command => proxy, + + transport_family => ipv4, + transport_protocol => stream, + + src_address => {192, 168, 1, 11}, + src_port => 54321, + dest_address => {192, 168, 1, 42}, + dest_port => 443 +}, +Data = ranch_proxy_header:parse(ProxyInfo). +---- + +.Build a PROXY protocol header with checksum and padding +[source,erlang] +---- +Data = ranch_proxy_header:parse(ProxyInfo, #{ + checksum => crc32, + padding => 7 +}). +---- + +== See also + +link:man:ranch_proxy_header:header(3)[ranch_proxy_header:header(3)], +link:man:ranch_proxy_header(3)[ranch_proxy_header(3)] + |