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   :: gun:req_headers()
ReqOpts   :: gun:req_opts()
StreamRef :: gun:stream_ref()

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

StreamRef = gun:get(ConnPid, "/articles", [
    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
]).

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)