Skip to content

Commit 8f28d29

Browse files
committed
Update README for async responses
1 parent 3876120 commit 8f28d29

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ Overview of response types for sync calls.
8080
<tr><td>bean&lt;E&gt</td><td>E</td></tr>
8181
<tr><td>list&lt;E&gt</td><td>List&lt;E&gt;</td></tr>
8282
<tr><td>stream&lt;E&gt</td><td>Stream&lt;E&gt;</td></tr>
83-
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt;)</td><td>E</td></tr>
83+
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt;)</td><td>HttpResponse&lt;E&gt;</td></tr>
8484
<tr><td>&nbsp;</td><td>&nbsp;</td></tr>
8585
<tr><td><b>async processing</b></td><td>&nbsp;</td></tr>
86-
<tr><td>asVoid</td><td>CompletableFuture&lt;Void&gt;</td></tr>
87-
<tr><td>asString</td><td>CompletableFuture&lt;String&gt;</td></tr>
86+
<tr><td>asVoid</td><td>CompletableFuture&lt;HttpResponse&lt;Void&gt;&gt;</td></tr>
87+
<tr><td>asString</td><td>CompletableFuture&lt;HttpResponse&lt;String&gt;&gt;</td></tr>
8888
<tr><td>bean&lt;E&gt</td><td>CompletableFuture&lt;E&gt;</td></tr>
8989
<tr><td>list&lt;E&gt</td><td>CompletableFuture&lt;List&lt;E&gt;&gt;</td></tr>
9090
<tr><td>stream&lt;E&gt</td><td>CompletableFuture&lt;Stream&lt;E&gt;&gt;</td></tr>
91-
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;E&gt;</td></tr>
91+
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
9292
</table>
9393

9494
### JDK BodyHandlers
@@ -246,15 +246,20 @@ assertThat(res.statusCode()).isEqualTo(201);
246246

247247
## Async processing
248248

249-
All async requests use JDK httpClient.sendAsync(...) returning CompletableFuture&lt;T&gt;
249+
All async requests use JDK httpClient.sendAsync(...) returning CompletableFuture. Commonly the
250+
`whenComplete()` callback will be used to process the async responses.
251+
252+
The `bean()`, `list()` and `stream()` responses throw a `HttpException` if
253+
the status code >= 400.
250254

251255
<table style="width:100%;">
252-
<tr><td>asVoid</td><td>CompletableFuture&lt;Void&gt;</td></tr>
253-
<tr><td>asString</td><td>CompletableFuture&lt;String&gt;</td></tr>
256+
<tr><td><b>async processing</b></td><td>&nbsp;</td></tr>
257+
<tr><td>asVoid</td><td>CompletableFuture&lt;HttpResponse&lt;Void&gt;&gt;</td></tr>
258+
<tr><td>asString</td><td>CompletableFuture&lt;HttpResponse&lt;String&gt;&gt;</td></tr>
254259
<tr><td>bean&lt;E&gt</td><td>CompletableFuture&lt;E&gt;</td></tr>
255260
<tr><td>list&lt;E&gt</td><td>CompletableFuture&lt;List&lt;E&gt;&gt;</td></tr>
256261
<tr><td>stream&lt;E&gt</td><td>CompletableFuture&lt;Stream&lt;E&gt;&gt;</td></tr>
257-
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;E&gt</td></tr>
262+
<tr><td>withHandler(HttpResponse.BodyHandler&lt;E&gt)</td><td>CompletableFuture&lt;HttpResponse&lt;E&gt;&gt;</td></tr>
258263
</table>
259264

260265
### .async().asDiscarding() - HttpResponse&lt;Void&gt;

0 commit comments

Comments
 (0)