From 24b2e92a06cf6275b972f66373d7bfea7bfc3518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Mon, 1 Oct 2018 16:35:30 +0200 Subject: Gun 1.3.0 --- docs/en/gun/1.3/manual/gun.get/index.html | 203 ++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 docs/en/gun/1.3/manual/gun.get/index.html (limited to 'docs/en/gun/1.3/manual/gun.get/index.html') diff --git a/docs/en/gun/1.3/manual/gun.get/index.html b/docs/en/gun/1.3/manual/gun.get/index.html new file mode 100644 index 00000000..905f5aa3 --- /dev/null +++ b/docs/en/gun/1.3/manual/gun.get/index.html @@ -0,0 +1,203 @@ + + + + + + + + + + Nine Nines: gun:get(3) + + + + + + + + + + + + + + +
+
+
+
+

99s

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

gun:get(3)

+ +

Name

+

gun:get - Get a resource representation

+

Description

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

Get a resource representation.

+

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 a resource representation
+
+
StreamRef = gun:get(ConnPid, "/articles", [
+    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
+]).
+
+
Get a resource representation with request options
+
+
StreamRef = gun:get(ConnPid, "/articles", [], #{
+    reply_to => ReplyToPid
+}).
+
+

See also

+

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

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

+ Gun + 1.3 + Function Reference + +

+ + + +

Navigation

+ +

Version select

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