From 441272421acfae86d3605e1533e0f5f3b9c2b1c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Wed, 3 Oct 2018 09:58:55 +0200 Subject: Cowboy 2.5.0 --- .../cowboy/2.5/manual/cowboy_req.push/index.html | 212 +++++++++++++++++++++ 1 file changed, 212 insertions(+) create mode 100644 docs/en/cowboy/2.5/manual/cowboy_req.push/index.html (limited to 'docs/en/cowboy/2.5/manual/cowboy_req.push/index.html') diff --git a/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html b/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html new file mode 100644 index 00000000..c9ac73b0 --- /dev/null +++ b/docs/en/cowboy/2.5/manual/cowboy_req.push/index.html @@ -0,0 +1,212 @@ + + + + + + + + + + Nine Nines: cowboy_req:push(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

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.

+

Note that clients may cancel the push or ignore it entirely. For example browsers may ignore the resource when the connection is not considered secure.

+

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),
+
+

See also

+

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

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

+ Cowboy + 2.5 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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