From 3d7d9e20fe46ed2839bc582d599abeac3ce19a8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 17 Sep 2018 16:05:10 +0200 Subject: Gun 1.2.0 and Ranch 1.6.2 --- docs/en/gun/1.2/manual/gun.head/index.html | 203 +++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 docs/en/gun/1.2/manual/gun.head/index.html (limited to 'docs/en/gun/1.2/manual/gun.head/index.html') diff --git a/docs/en/gun/1.2/manual/gun.head/index.html b/docs/en/gun/1.2/manual/gun.head/index.html new file mode 100644 index 00000000..08ae2464 --- /dev/null +++ b/docs/en/gun/1.2/manual/gun.head/index.html @@ -0,0 +1,203 @@ + + + + + + + + + + Nine Nines: gun:head(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

gun:head(3)

+ +

Name

+

gun:head - Get headers of a resource representation

+

Description

+
+
head(ConnPid, Path)
+    -> head(ConnPid, Path, [], #{}).
+
+head(ConnPid, Path, Headers)
+    -> head(ConnPid, Path, Headers, #{})
+
+head(ConnPid, Path, Headers, ReqOpts)
+    -> StreamRef
+
+ConnPid   :: pid()
+Path      :: iodata()
+Headers   :: [{binary(), iodata()}]
+ReqOpts   :: gun:req_opts()
+StreamRef :: reference()
+
+

Get headers of a resource representation.

+

This function performs the same operation as gun:get(3), except the server will not send the resource representation, only the response's status code and headers.

+

While servers are supposed to send the same headers as for a GET request, they sometimes will not. For example the content-length header may be dropped from the response.

+

Arguments

+
ConnPid
+

The pid of the Gun connection process.

+
+
Path
+

Path to the resource.

+
+
Headers
+

Additional request headers.

+
+
ReqOpts
+

Request options.

+
+
+

Return value

+

A reference that identifies the newly created stream is returned. It is this reference that must be passed in subsequent calls and will be received in messages related to this new stream.

+

Changelog

+
  • 1.0: Function introduced. +
    • +
+

Examples

+
Get headers of a resource representation
+
+
StreamRef = gun:head(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
+
+
Get headers of a resource representation with request options
+
+
StreamRef = gun:head(ConnPid, "/articles", [], #{
+    reply_to => ReplyToPid
+}).
+
+

See also

+

gun(3), gun:head(3), gun:await(3), gun_push(3), gun_inform(3), gun_response(3)

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

+ Gun + 1.2 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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