Skip to content

Commit dd5df0d

Browse files
committed
Rename HttpClientRequest#setIdleTimeout -> idleTimeout
1 parent 75d6dc2 commit dd5df0d

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

src/main/asciidoc/http.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1083,7 +1083,7 @@ no need to set the `Content-Length` of the request up-front.
10831083

10841084
==== Request timeouts
10851085

1086-
You can set an idle timeout to prevent your application from unresponsive servers using {@link io.vertx.core.http.RequestOptions#setIdleTimeout(long)} or {@link io.vertx.core.http.HttpClientRequest#setIdleTimeout(long)}. When the request does not return any data within the timeout period an exception will fail the result and the request will be reset.
1086+
You can set an idle timeout to prevent your application from unresponsive servers using {@link io.vertx.core.http.RequestOptions#setIdleTimeout(long)} or {@link io.vertx.core.http.HttpClientRequest#idleTimeout(long)}. When the request does not return any data within the timeout period an exception will fail the result and the request will be reset.
10871087

10881088
[source,$lang]
10891089
----

src/main/java/io/vertx/core/http/HttpClientRequest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -530,9 +530,9 @@ default Future<HttpClientResponse> send(ReadStream<Buffer> body) {
530530
void end(Handler<AsyncResult<Void>> handler);
531531

532532
/**
533-
* Like {@link #setIdleTimeout(long)} but with a confusing name (hence the deprecation).
533+
* Like {@link #idleTimeout(long)} but with a confusing name (hence the deprecation).
534534
*
535-
* @deprecated instead use {@link #setIdleTimeout(long)}
535+
* @deprecated instead use {@link #idleTimeout(long)}
536536
*/
537537
@Deprecated
538538
@Fluent
@@ -547,7 +547,7 @@ default Future<HttpClientResponse> send(ReadStream<Buffer> body) {
547547
* @return a reference to this, so the API can be used fluently
548548
*/
549549
@Fluent
550-
default HttpClientRequest setIdleTimeout(long timeout) {
550+
default HttpClientRequest idleTimeout(long timeout) {
551551
return setTimeout(timeout);
552552
}
553553

src/main/java/io/vertx/core/http/RequestOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ public long getIdleTimeout() {
406406
* e.g. {@code Future<HttpClientResponse>} or {@code Future<Buffer>} response body.
407407
*
408408
* <p/>The timeout starts after a connection is obtained from the client, similar to calling
409-
* {@link HttpClientRequest#setIdleTimeout(long)}.
409+
* {@link HttpClientRequest#idleTimeout(long)}.
410410
*
411411
* @param timeout the amount of time in milliseconds.
412412
* @return a reference to this, so the API can be used fluently

src/main/java/io/vertx/core/http/impl/HttpClientImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ public Endpoint<Lease<HttpClientConnection>> create(ContextInternal ctx, Runnabl
387387
req.setFollowRedirects(followRedirects);
388388
}
389389
if (idleTimeout > 0L) {
390-
req.setIdleTimeout(idleTimeout);
390+
req.idleTimeout(idleTimeout);
391391
}
392392
requestPromise.tryComplete(req);
393393
} else {

src/test/java/io/vertx/core/http/HttpClientTimeoutTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ public void start() throws Exception {
199199
for (int i = 0;i < n;i++) {
200200
AtomicBoolean responseReceived = new AtomicBoolean();
201201
client.request(requestOptions).onComplete(onSuccess(req -> {
202-
req.setIdleTimeout(500);
202+
req.idleTimeout(500);
203203
req.send(onSuccess(resp -> {
204204
try {
205205
Thread.sleep(150);
@@ -225,7 +225,7 @@ public void testRequestIdleTimeoutCanceledWhenRequestEndsNormally() {
225225
client.request(requestOptions).onComplete(onSuccess(req -> {
226226
req
227227
.exceptionHandler(exception::set)
228-
.setIdleTimeout(500)
228+
.idleTimeout(500)
229229
.end();
230230
vertx.setTimer(1000, id -> {
231231
assertNull("Did not expect any exception", exception.get());
@@ -267,7 +267,7 @@ public void testHttpClientRequestIdleTimeoutResetsTheConnection() throws Excepti
267267
req.response(onFailure(err -> {
268268
complete();
269269
}));
270-
req.setChunked(true).sendHead(onSuccess(version -> req.setIdleTimeout(500)));
270+
req.setChunked(true).sendHead(onSuccess(version -> req.idleTimeout(500)));
271271
AtomicBoolean errored = new AtomicBoolean();
272272
req.exceptionHandler(err -> {
273273
if (errored.compareAndSet(false, true)) {
@@ -297,7 +297,7 @@ public void testResponseDataIdleTimeout() {
297297
complete();
298298
}
299299
});
300-
resp.request().setIdleTimeout(500);
300+
resp.request().idleTimeout(500);
301301
resp.handler(buff -> {
302302
received.appendBuffer(buff);
303303
// Force the internal timer to be rescheduled with the remaining amount of time

0 commit comments

Comments
 (0)