From a983ecef672e3e417b678366d783084ae9f9199d Mon Sep 17 00:00:00 2001
From: Javier Eguiluz <javier.eguiluz@gmail.com>
Date: Tue, 4 Jun 2019 10:42:38 +0200
Subject: [PATCH] [HttpClient] Documented the cancel() method

---
 components/http_client.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/components/http_client.rst b/components/http_client.rst
index c5a829eae18..cf037c90edf 100644
--- a/components/http_client.rst
+++ b/components/http_client.rst
@@ -380,6 +380,23 @@ the "foreach" in the snippet with this one, the code becomes fully async::
     Use the ``user_data`` option combined with ``$response->getInfo('user_data')``
     to track the identity of the responses in your foreach loops.
 
+Canceling Responses
+~~~~~~~~~~~~~~~~~~~
+
+Responses can be canceled at any moment before they are completed using the
+``cancel()`` method::
+
+    foreach ($client->stream($responses) as $response => $chunk) {
+        // ...
+
+        // if some condition happens, cancel the response
+        $response->cancel();
+    }
+
+.. versionadded:: 4.4
+
+    The ``cancel()`` method was introduced in Symfony 4.4.
+
 Dealing with Network Timeouts
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~