public interface HttpClientRequest extends WriteStream<Buffer>, ReadStream<HttpClientResponse>
Instances are created by an HttpClient instance, via one of the methods corresponding to the
specific HTTP methods, or the generic request methods. On creation the request will not have been written to the
wire.
Once a request has been obtained, headers can be set on it, and data can be written to its body if required. Once
you are ready to send the request, one of the end() methods should be called.
Nothing is actually sent until the request has been internally assigned an HTTP connection.
The HttpClient instance will return an instance of this class immediately, even if there are no HTTP
connections available in the pool. Any requests sent before a connection is assigned will be queued
internally and actually sent when an HTTP connection becomes available from the pool.
The headers of the request are queued for writing either when the end() method is called, or, when the first
part of the body is written, whichever occurs first.
This class supports both chunked and non-chunked HTTP.
It implements WriteStream so it can be used with
Pump to pump data with flow control.
An example of using this class is as follows:
| Modifier and Type | Method and Description |
|---|---|
String |
absoluteURI() |
HttpConnection |
connection() |
HttpClientRequest |
connectionHandler(Handler<HttpConnection> handler)
Deprecated.
instead use
HttpClient.connectionHandler(Handler) |
HttpClientRequest |
continueHandler(Handler<Void> handler)
If you send an HTTP request with the header
Expect set to the value 100-continue
and the server responds with an interim HTTP response with a status code of 100 and a continue handler
has been set using this method, then the handler will be called. |
HttpClientRequest |
drainHandler(Handler<Void> handler)
Set a drain handler on the stream.
|
void |
end()
Ends the request.
|
void |
end(Buffer chunk)
Same as
end() but writes some data to the request body before ending. |
void |
end(Buffer chunk,
Handler<AsyncResult<Void>> handler)
Same as
end(String) but with an handler called when the operation completes |
void |
end(Handler<AsyncResult<Void>> handler)
Same as
end() but with an handler called when the operation completes |
void |
end(String chunk)
Same as
end(Buffer) but writes a String in UTF-8 encoding |
void |
end(String chunk,
Handler<AsyncResult<Void>> handler)
Same as
end(String) but with an handler called when the operation completes |
void |
end(String chunk,
String enc)
Same as
end(Buffer) but writes a String with the specified encoding |
void |
end(String chunk,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
end(String,String) but with an handler called when the operation completes |
HttpClientRequest |
endHandler(Handler<Void> endHandler)
Deprecated.
this method will be removed in Vert.x 4
|
HttpClientRequest |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the write stream.
|
HttpClientRequest |
fetch(long amount)
Deprecated.
this method will be removed in Vert.x 4
|
String |
getHost() |
String |
getRawMethod() |
StreamPriority |
getStreamPriority() |
HttpClientRequest |
handler(Handler<HttpClientResponse> handler)
Deprecated.
this method will break in Vert.x 4, the handler will use an
Handler<AsyncResult<HttpClientResponse>> |
MultiMap |
headers() |
boolean |
isChunked() |
HttpMethod |
method()
The HTTP method for the request.
|
String |
path() |
HttpClientRequest |
pause()
Deprecated.
this method will be removed in Vert.x 4
|
HttpClientRequest |
pushHandler(Handler<HttpClientRequest> handler)
Set a push handler for this request.
The handler is called when the client receives a push promise from the server.
|
HttpClientRequest |
putHeader(CharSequence name,
CharSequence value)
Like
putHeader(String, String) but using CharSequence |
HttpClientRequest |
putHeader(CharSequence name,
Iterable<CharSequence> values)
Like
putHeader(String, Iterable) but using CharSequence |
HttpClientRequest |
putHeader(String name,
Iterable<String> values)
Put an HTTP header with multiple values
|
HttpClientRequest |
putHeader(String name,
String value)
Put an HTTP header
|
String |
query() |
default boolean |
reset()
Reset this stream with the error code
0. |
boolean |
reset(long code)
Reset this request:
for HTTP/2, this performs send an HTTP/2 reset frame with the specified error
code
for HTTP/1.x, this closes the connection when the current request is inflight
When the request has not yet been sent, the request will be aborted and false is returned as indicator. |
HttpClientRequest |
resume()
Deprecated.
this method will be removed in Vert.x 4
|
HttpClientRequest |
sendHead()
Forces the head of the request to be written before
end() is called on the request or any data is
written to it. |
HttpClientRequest |
sendHead(Handler<HttpVersion> completionHandler)
Like
sendHead() but with an handler after headers have been sent. |
HttpClientRequest |
setChunked(boolean chunked)
If chunked is true then the request will be set into HTTP chunked mode
|
HttpClientRequest |
setFollowRedirects(boolean followRedirects)
Set the request to follow HTTP redirects up to
HttpClientOptions.getMaxRedirects(). |
HttpClientRequest |
setHost(String host)
Set the request host.
For HTTP/2 it sets the :authority pseudo header otherwise it sets the Host header
|
HttpClientRequest |
setMaxRedirects(int maxRedirects)
Set the max number of HTTP redirects this request will follow.
|
HttpClientRequest |
setRawMethod(String method)
Set the value the method to send when the method
HttpMethod.OTHER is used. |
default HttpClientRequest |
setStreamPriority(StreamPriority streamPriority)
Sets the priority of the associated stream.
|
HttpClientRequest |
setTimeout(long timeoutMs)
Set's the amount of time after which if the request does not return any data within the timeout period an
TimeoutException will be passed to the exception handler (if provided) and
the request will be closed. |
HttpClientRequest |
setWriteQueueMaxSize(int maxSize)
Set the maximum size of the write queue to
maxSize. |
default int |
streamId() |
String |
uri() |
HttpClientRequest |
write(Buffer data)
Write some data to the stream.
|
HttpClientRequest |
write(Buffer data,
Handler<AsyncResult<Void>> handler)
Same as
write(Buffer) but with an handler called when the operation completes |
HttpClientRequest |
write(String chunk)
Write a
String to the request body, encoded as UTF-8. |
HttpClientRequest |
write(String chunk,
Handler<AsyncResult<Void>> handler)
Same as
write(String) but with an handler called when the operation completes |
HttpClientRequest |
write(String chunk,
String enc)
Write a
String to the request body, encoded using the encoding enc. |
HttpClientRequest |
write(String chunk,
String enc,
Handler<AsyncResult<Void>> handler)
Same as
write(String,String) but with an handler called when the operation completes |
default HttpClientRequest |
writeCustomFrame(HttpFrame frame)
Like
writeCustomFrame(int, int, Buffer) but with an HttpFrame. |
HttpClientRequest |
writeCustomFrame(int type,
int flags,
Buffer payload)
Write an HTTP/2 frame to the request, allowing to extend the HTTP/2 protocol.
|
writeQueueFullpipe, pipeTo, pipeToHttpClientRequest exceptionHandler(Handler<Throwable> handler)
WriteStreamexceptionHandler in interface ReadStream<HttpClientResponse>exceptionHandler in interface StreamBaseexceptionHandler in interface WriteStream<Buffer>handler - the exception handlerHttpClientRequest write(Buffer data)
WriteStreamWriteStream.writeQueueFull() method before writing. This is done automatically if using a Pump.write in interface WriteStream<Buffer>data - the data to writeIllegalStateException - when no response handler is setHttpClientRequest write(Buffer data, Handler<AsyncResult<Void>> handler)
write(Buffer) but with an handler called when the operation completeswrite in interface WriteStream<Buffer>HttpClientRequest setWriteQueueMaxSize(int maxSize)
WriteStreammaxSize. You will still be able to write to the stream even
if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
Pump to provide flow control.
The value is defined by the implementation of the stream, e.g in bytes for a
NetSocket, the number of Message for a
MessageProducer, etc...setWriteQueueMaxSize in interface WriteStream<Buffer>maxSize - the max size of the write streamHttpClientRequest drainHandler(Handler<Void> handler)
WriteStreamPump for an example of this being used.
The stream implementation defines when the drain handler, for example it could be when the queue size has been
reduced to maxSize / 2.drainHandler in interface WriteStream<Buffer>handler - the handler@Deprecated HttpClientRequest handler(Handler<HttpClientResponse> handler)
Handler<AsyncResult<HttpClientResponse>>ReadStreamhandler in interface ReadStream<HttpClientResponse>@Deprecated HttpClientRequest pause()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<HttpClientResponse>@Deprecated HttpClientRequest resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<HttpClientResponse>@Deprecated HttpClientRequest fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<HttpClientResponse>@Deprecated HttpClientRequest endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<HttpClientResponse>HttpClientRequest setFollowRedirects(boolean followRedirects)
HttpClientOptions.getMaxRedirects().followRedirects - true to follow HTTP redirectsHttpClientRequest setMaxRedirects(int maxRedirects)
0 which means
no redirects.maxRedirects - the number of HTTP redirect to followHttpClientRequest setChunked(boolean chunked)
chunked - true if chunked encodingboolean isChunked()
HttpMethod method()
String getRawMethod()
HttpClientRequest setRawMethod(String method)
HttpMethod.OTHER is used.method - the raw methodString absoluteURI()
String uri()
String path()
String query()
HttpClientRequest setHost(String host)
String getHost()
MultiMap headers()
HttpClientRequest putHeader(String name, String value)
name - The header namevalue - The header valueHttpClientRequest putHeader(CharSequence name, CharSequence value)
putHeader(String, String) but using CharSequenceHttpClientRequest putHeader(String name, Iterable<String> values)
name - The header namevalues - The header valuesHttpClientRequest putHeader(CharSequence name, Iterable<CharSequence> values)
putHeader(String, Iterable) but using CharSequenceHttpClientRequest write(String chunk)
String to the request body, encoded as UTF-8.IllegalStateException - when no response handler is setHttpClientRequest write(String chunk, Handler<AsyncResult<Void>> handler)
write(String) but with an handler called when the operation completesHttpClientRequest write(String chunk, String enc)
String to the request body, encoded using the encoding enc.IllegalStateException - when no response handler is setHttpClientRequest write(String chunk, String enc, Handler<AsyncResult<Void>> handler)
write(String,String) but with an handler called when the operation completesHttpClientRequest continueHandler(Handler<Void> handler)
Expect set to the value 100-continue
and the server responds with an interim HTTP response with a status code of 100 and a continue handler
has been set using this method, then the handler will be called.
You can then continue to write data to the request body and later end it. This is normally used in conjunction with
the sendHead() method to force the request header to be written before the request has ended.
HttpClientRequest sendHead()
end() is called on the request or any data is
written to it.
This is normally used to implement HTTP 100-continue handling, see continueHandler(io.vertx.core.Handler) for
more information.
IllegalStateException - when no response handler is setHttpClientRequest sendHead(Handler<HttpVersion> completionHandler)
sendHead() but with an handler after headers have been sent. The handler will be called with
the HttpVersion if it can be determined or null otherwise.void end(String chunk)
end(Buffer) but writes a String in UTF-8 encodingIllegalStateException - when no response handler is setvoid end(String chunk, Handler<AsyncResult<Void>> handler)
end(String) but with an handler called when the operation completesvoid end(String chunk, String enc)
end(Buffer) but writes a String with the specified encodingIllegalStateException - when no response handler is setvoid end(String chunk, String enc, Handler<AsyncResult<Void>> handler)
end(String,String) but with an handler called when the operation completesvoid end(Buffer chunk)
end() but writes some data to the request body before ending. If the request is not chunked and
no other data has been written then the Content-Length header will be automatically setend in interface WriteStream<Buffer>chunk - the data to writeIllegalStateException - when no response handler is setvoid end(Buffer chunk, Handler<AsyncResult<Void>> handler)
end(String) but with an handler called when the operation completesend in interface WriteStream<Buffer>void end()
sendHead() has not been called then
the actual request won't get written until this method gets called.
Once the request has ended, it cannot be used any more,
end in interface WriteStream<Buffer>IllegalStateException - when no response handler is setvoid end(Handler<AsyncResult<Void>> handler)
end() but with an handler called when the operation completesend in interface WriteStream<Buffer>HttpClientRequest setTimeout(long timeoutMs)
TimeoutException will be passed to the exception handler (if provided) and
the request will be closed.
Calling this method more than once has the effect of canceling any existing timeout and starting the timeout from scratch.
timeoutMs - The quantity of time in milliseconds.HttpClientRequest pushHandler(Handler<HttpClientRequest> handler)
HttpClientRequest, the following methods can be called:
In addition the handler should call the handler(io.vertx.core.Handler<io.vertx.core.http.HttpClientResponse>) method to set an handler to
process the response.handler - the handlerdefault boolean reset()
0.reset(long)boolean reset(long code)
codecode - the error codeHttpConnection connection()
HttpConnection associated with this request@Deprecated HttpClientRequest connectionHandler(Handler<HttpConnection> handler)
HttpClient.connectionHandler(Handler)handler - the handlerHttpClientRequest writeCustomFrame(int type, int flags, Buffer payload)
The frame is sent immediatly and is not subject to flow control.
This method must be called after the request headers have been sent and only for the protocol HTTP/2.
The sendHead(Handler) should be used for this purpose.
type - the 8-bit frame typeflags - the 8-bit frame flagspayload - the frame payloaddefault int streamId()
default HttpClientRequest writeCustomFrame(HttpFrame frame)
writeCustomFrame(int, int, Buffer) but with an HttpFrame.frame - the frame to writedefault HttpClientRequest setStreamPriority(StreamPriority streamPriority)
streamPriority - the priority of this request's streamStreamPriority getStreamPriority()
nullCopyright © 2023 Eclipse. All rights reserved.