From 9cbc272ddbff2da9c8ac18c2c6b0f29d22500cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 3 Sep 2021 15:27:15 +0200 Subject: Add function ranch_proxy_header:to_connection_info/1 --- doc/src/manual/ranch_proxy_header.asciidoc | 1 + doc/src/manual/ranch_proxy_header.parse.asciidoc | 1 + .../ranch_proxy_header.to_connection_info.asciidoc | 49 ++++++++++++++++++++++ 3 files changed, 51 insertions(+) create mode 100644 doc/src/manual/ranch_proxy_header.to_connection_info.asciidoc (limited to 'doc') diff --git a/doc/src/manual/ranch_proxy_header.asciidoc b/doc/src/manual/ranch_proxy_header.asciidoc index 04f183b..c194d98 100644 --- a/doc/src/manual/ranch_proxy_header.asciidoc +++ b/doc/src/manual/ranch_proxy_header.asciidoc @@ -13,6 +13,7 @@ for parsing and building the PROXY protocol header. * link:man:ranch_proxy_header:parse(3)[ranch_proxy_header:parse(3)] - Parse a PROXY protocol header * link:man:ranch_proxy_header:header(3)[ranch_proxy_header:header(3)] - Build a PROXY protocol header +* link:man:ranch_proxy_header:to_connection_info(3)[ranch_proxy_header:to_connection_info(3)] - Convert proxy_info() to ssl:connection_info() == Types diff --git a/doc/src/manual/ranch_proxy_header.parse.asciidoc b/doc/src/manual/ranch_proxy_header.parse.asciidoc index 6c22672..5e03a83 100644 --- a/doc/src/manual/ranch_proxy_header.parse.asciidoc +++ b/doc/src/manual/ranch_proxy_header.parse.asciidoc @@ -46,4 +46,5 @@ error. == See also link:man:ranch_proxy_header:header(3)[ranch_proxy_header:header(3)], +link:man:ranch_proxy_header:to_connection_info(3)[ranch_proxy_header:to_connection_info(3)], link:man:ranch_proxy_header(3)[ranch_proxy_header(3)] diff --git a/doc/src/manual/ranch_proxy_header.to_connection_info.asciidoc b/doc/src/manual/ranch_proxy_header.to_connection_info.asciidoc new file mode 100644 index 0000000..9a53723 --- /dev/null +++ b/doc/src/manual/ranch_proxy_header.to_connection_info.asciidoc @@ -0,0 +1,49 @@ += ranch_proxy_header:to_connection_info(3) + +== Name + +ranch_proxy_header:to_connection_info - Convert proxy_info() to ssl:connection_info() + +== Description + +[source,erlang] +---- +to_connection_info(ProxyInfo :: proxy_info()) + -> ssl:connection_info() +---- + +Convert `ranch_proxy_header:proxy_info()` information +to the `ssl:connection_info()` format returned by +`ssl:connection_information/1,2`. + +== Arguments + +ProxyInfo:: + +The PROXY protocol information. + +== Return value + +Connection information is returned as a proplist. + +Because the PROXY protocol header includes limited +information, only the keys `protocol`, `selected_cipher_suite` +and `sni_hostname` will be returned, at most. All keys +are optional. + +== Changelog + +* *2.1*: Function introduced. + +== Examples + +.Convert the PROXY protocol information +[source,erlang] +---- +ConnInfo = ranch_proxy_header:to_connection_info(ProxyInfo). +---- + +== See also + +link:man:ranch_proxy_header:parse(3)[ranch_proxy_header:parse(3)], +link:man:ranch_proxy_header(3)[ranch_proxy_header(3)] -- cgit v1.2.3