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.
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:
gun_push(3) - Server-initiated push
gun_inform(3) - Informational response
gun_response(3) - Response
gun_data(3) - Response body
gun_trailers(3) - Response trailers
1.0: Function introduced.
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).
