gun:await - Wait for a response


await(ConnPid, StreamRef)
    -> await(ConnPid, StreamRef, 5000, MonitorRef)

await(ConnPid, StreamRef, MonitorRef)
    -> await(ConnPid, StreamRef, 5000, MonitorRef)

await(ConnPid, StreamRef, Timeout)
    -> await(ConnPid, StreamRef, Timeout, MonitorRef)

await(ConnPid, StreamRef, Timeout, MonitorRef)
    -> Result

ConnPid    :: pid()
StreamRef  :: reference()
MonitorRef :: reference()
Timeout    :: timeout()
Result     :: tuple() - see below

Wait for a response.

This function waits for a message from the given stream and returns it as a tuple. An error will be returned should the process fail or a relevant message is not received within the specified duration.



The pid of the Gun connection process.


Identifier of the stream for the original request.


How long to wait for a message, in milliseconds.


Monitor for the Gun connection process.

A monitor is automatically created for the duration of this call when one is not provided.

Return value

A number of different tuples can be returned. They correspond to the message of the same name and they contain the same elements minus the pid and stream reference. Error tuples may also be returned when a timeout or an error occur.

Result :: {inform, Status, Headers}
          {response, IsFin, Status, Headers}
          {data, IsFin, Data}
          {trailers, Trailers}
          {push, NewStreamRef, Method, URI, Headers}
          {error, Reason}

Reason :: timeout | any()

Because the messages and returned tuples are equivalent, please refer to the manual pages for each message for further information:


  • 1.0: Function introduced.


Wait for a response
StreamRef = gun:get(ConnPid, "/articles", [
    {<<"accept">>, <<"text/html;q=1.0, application/xml;q=0.1">>}
{response, nofin, 200, _Headers} = gun:await(ConnPid, StreamRef).
{data, fin, <<"Hello world!">>} = gun:await(ConnPid, StreamRef).

See also

gun(3), gun:get(3), gun:head(3), gun:options(3), gun:patch(3), gun:post(3), gun:put(3), gun:delete(3), gun:request(3), gun:await_body(3)

Gun 1.3 Function Reference


Version select

Like my work? Donate!

Donate to Loïc Hoguin because his work on Cowboy, Ranch, Gun and is fantastic:

Recurring payment options are also available via GitHub Sponsors. These funds are used to cover the recurring expenses like food, dedicated servers or domain names.