From 48f39402181d959cad88cb3f460210c007169f50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 12 May 2021 11:13:47 +0200 Subject: Cowboy 2.9.0 --- .../1.8/manual/ranch_proxy_header.parse/index.html | 191 +++++++++++++++++++++ 1 file changed, 191 insertions(+) create mode 100644 docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html (limited to 'docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html') diff --git a/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html b/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html new file mode 100644 index 00000000..2489ce91 --- /dev/null +++ b/docs/en/ranch/1.8/manual/ranch_proxy_header.parse/index.html @@ -0,0 +1,191 @@ + + + + + + + + + + Nine Nines: ranch_proxy_header:parse(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

+
+
+ +
+ +
    +
  • + Github +
    • +
  • + +
    • +
+
+
+
+
+ + +
+ +
+
+
+
+ +

ranch_proxy_header:parse(3)

+ +

Name

+

ranch_proxy_header:parse - Parse a PROXY protocol header

+

Description

+
+
parse(Data :: binary())
+    -> {ok, ranch_proxy_header:proxy_info(), Rest :: binary()}
+     | {error, HumanReadable :: atom()}
+
+

Parse a PROXY protocol header.

+

Arguments

+
Data
+

The PROXY protocol header optionally followed by more data.

+
+
+

Return value

+

An ok tuple is returned on success, containing the proxy information found in the header and the rest of the data if more was provided.

+

An error tuple is returned when a protocol error is detected. It contains a human readable message about the error.

+

Changelog

+
  • 1.7: Function introduced. +
    • +
+

Examples

+
Parse the PROXY protocol header
+
+
{ok ProxyInfo, Rest} = ranch_proxy_header:parse(Data).
+
+

See also

+

ranch_proxy_header:header(3), ranch_proxy_header(3)

+ + + + + + +
+ +
+ + +

+ Ranch + 1.8 + Function Reference + +

+ + + +

Navigation

+ +

Version select

+ + +

Like my work? Donate!

+

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and Erlang.mk is fantastic:

+
+ + + + + + + + + +

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.

+ + + +
+
+
+
+ + + + + + + + + -- cgit v1.2.3