Skip to content

[HttpClient] Improve the wording about asynchronous requests #21650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
javiereguiluz wants to merge 1 commit into
base: 6.4
Choose a base branch
from
+11 −8
Open

[HttpClient] Improve the wording about asynchronous requests #21650

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions http_client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,21 +375,22 @@ HTTP requests::
],
]);

Responses are always asynchronous, so that the call to the method returns
immediately instead of waiting to receive the response::
Symfony's HTTP client is asynchronous by default. When you call ``request()``,
the HTTP request starts immediately, but the method returns without waiting for
Copy link
Member

@nicolas-grekas nicolas-grekas Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the HTTP request starts immediately, but the method returns without waiting for
the HTTP request might start immediately, but the method returns without waiting for

Copy link
Member Author

@javiereguiluz javiereguiluz Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But if we say "might start" ... then we need to explain when it starts and when it doesn't. Please, share some details about this. Thanks.

Copy link
Member

@nicolas-grekas nicolas-grekas Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, curl does. We don't care here, that's the whole point

a response. Your code only blocks when you actually need the response data::

// code execution continues immediately; it doesn't wait to receive the response
// the request starts, but execution continues without waiting
Copy link
Member

@nicolas-grekas nicolas-grekas Dec 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// the request starts, but execution continues without waiting
// the request might start, but execution continues without waiting

$response = $client->request('GET', 'http://releases.ubuntu.com/18.04.2/ubuntu-18.04.2-desktop-amd64.iso');

// getting the response headers waits until they arrive
// this blocks until the response headers are received
$contentType = $response->getHeaders()['content-type'][0];

// trying to get the response content will block the execution until
// the full response content is received
// this blocks until the full response body is received
$content = $response->getContent();

This component also supports :ref:`streaming responses <http-client-streaming-responses>`
for full asynchronous applications.
The HTTP client also supports :ref:`concurrent requests <http-client-concurrent-requests>`
to make multiple HTTP requests in parallel, and :ref:`streaming responses <http-client-streaming-responses>`
to process response data in chunks for fully asynchronous applications.

Authentication
~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1327,6 +1328,8 @@ the error-handling code (by calling ``$response->getStatusCode()``), you will
opt-out from these fallback mechanisms as the destructor won't have anything
remaining to do.

.. _http-client-concurrent-requests:

Concurrent Requests
-------------------

Expand Down