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.push/index.html | 225 --------------------- 1 file changed, 225 deletions(-) delete mode 100644 docs/en/cowboy/2.4/manual/cowboy_req.push/index.html (limited to 'docs/en/cowboy/2.4/manual/cowboy_req.push/index.html') diff --git a/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html deleted file mode 100644 index e602f7fa..00000000 --- a/docs/en/cowboy/2.4/manual/cowboy_req.push/index.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - - - - - Nine Nines: cowboy_req:push(3) - - - - - - - - - - - - - -

- - - -

- -

cowboy_req:push(3)

- -

Name

cowboy_req:push - Push a resource to the client

Description

push(Path, Headers, Req :: cowboy_req:req())
-    -> push(Path, Headers, Req, #{})
-
-push(Path, Headers, Req :: cowboy_req:req(), Opts)
-    -> ok
-
-Path    :: iodata()                %% case sensitive
-Headers :: cowboy:http_headers()
-Opts    :: cowboy_req:push_opts()

Push a resource to the client.

Cowboy handles push requests the same way as if they came from the client, including the creation of a request handling process, routing and middlewares and so on.

This function does nothing when the HTTP/1.1 protocol is used. You may call it safely without first checking whether the connection uses HTTP/2.

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.

Note that the headers must be the headers the client is expected to send if it were to perform the request. They are therefore request headers, and not response headers.

By default, Cowboy will use the GET method, an empty query string, and take the scheme, host and port directly from the current request's URI. You can override them by passing options.

It is not possible to push resources after sending a response. Any attempt will result in an error.

Arguments

Path: The status code for the response.
-
Headers: The response headers.
-

Header names must be given as lowercase binary strings.

Req: The Req object.
-
Opts: Customize the HTTP method or the URI scheme, host, port or query string.
-

Return value

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

Changelog

2.0: Function introduced. -

Examples

Push a resource

cowboy_req:push("/static/style.css", #{
-    <<"accept">> => <<"text/css">>
-}, Req),

Push a resource with a custom host

cowboy_req:push("/static/style.css", #{
-    <<"accept">> => <<"text/css">>
-}, #{host => <<"cdn.example.org">>}, Req),

99s

cowboy_req:push(3)

Name

Description

Arguments

Return value

Changelog

Examples

See also

- Cowboy - 2.4 - Function Reference - -

Navigation

Version select

Like my work? Donate!