From d7580dbfdbdcf3ecf085479b6550284a47745138 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 28 Apr 2023 13:34:22 +0200 Subject: Cowboy 2.10.0 --- .../cowboy/2.4/manual/cowboy_req.inform/index.html | 217 --------------------- 1 file changed, 217 deletions(-) delete mode 100644 docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html (limited to 'docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html') diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html deleted file mode 100644 index 75b71db3..00000000 --- a/docs/en/cowboy/2.4/manual/cowboy_req.inform/index.html +++ /dev/null @@ -1,217 +0,0 @@ - - - - - - - - - - Nine Nines: cowboy_req:inform(3) - - - - - - - - - - - - - -
-
-
-
-

99s

-
-
- -
- -
    -
  • - Github -
    • -
  • - -
    • -
-
-
-
-
- - -
- -
-
-
-
- -

cowboy_req:inform(3)

- -

Name

-

cowboy_req:inform - Send an informational response

-

Description

-
-
inform(Status, Req :: cowboy_req:req())
-    -> inform(StatusCode, #{}, Req)
-
-inform(Status, Headers, Req :: cowboy_req:req())
-    -> ok
-
-Status  :: cowboy:http_status()
-Headers :: cowboy:http_headers()
-
-

Send an informational response.

-

Informational responses use a status code between 100 and 199. They cannot include a body. This function will not use any of the previously set headers. All headers to be sent must be given directly.

-

Any number of informational responses can be sent as long as they are sent before the proper response. Attempting to use this function after sending a normal response will result in an error.

-

The header names must be given as lowercase binary strings. While header names are case insensitive, Cowboy requires them to be given as lowercase to function properly.

-

Arguments

-
Status
-

The status code for the response.

-
-
Headers
-

The response headers.

-
-
-

Header names must be given as lowercase binary strings.

-
Req
-

The Req object.

-
-
-

Return value

-

The atom ok is always returned. It can be safely ignored.

-

Changelog

-
  • 2.1: Function introduced. -
    • -
-

Examples

-
Send an informational response
-
-
Req = cowboy_req:inform(102, Req0).
-
-
Send an informational response with headers
-
-
Req = cowboy_req:inform(103, #{
-    <<"link">> => <<"</style.css>; rel=preload; as=style">>,
-    <<"link">> => <<"</script.js>; rel=preload; as=script">>
-}, Req0).
-
-

See also

-

cowboy_req(3), cowboy_req:reply(3), cowboy_req:stream_reply(3), cowboy_req:push(3)

- - - - - - -
- -
- - -

- Cowboy - 2.4 - 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