Class HttpClientResponse
- java.lang.Object
-
- io.vertx.reactivex.core.http.HttpClientResponse
-
- All Implemented Interfaces:
ReadStream<Buffer>
,StreamBase
public class HttpClientResponse extends Object implements ReadStream<Buffer>
Represents a client-side HTTP response.Vert.x provides you with one of these via the handler that was provided when creating the
HttpClientRequest
or that was set on theHttpClientRequest
instance.It implements
NOTE: This class has been automatically generated from theReadStream
so it can be used withPipe
to pipe data with flow control.original
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<HttpClientResponse>
__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HttpClientResponse(HttpClientResponse delegate)
HttpClientResponse(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description HttpClientResponse
body()
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completesHttpClientResponse
body(Handler<AsyncResult<Buffer>> handler)
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completesHttpClientResponse
bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.List<String>
cookies()
HttpClientResponse
customFrameHandler(Handler<HttpFrame> handler)
Set an custom frame handler.void
end()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesvoid
end(Handler<AsyncResult<Void>> handler)
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesHttpClientResponse
endHandler(Handler<Void> endHandler)
Set an end handler.boolean
equals(Object o)
HttpClientResponse
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.HttpClientResponse
fetch(long amount)
Fetch the specifiedamount
of elements.HttpClientResponse
getDelegate()
String
getHeader(CharSequence headerName)
Return the first header value with the specified nameString
getHeader(String headerName)
Return the first header value with the specified nameString
getTrailer(String trailerName)
Return the first trailer value with the specified nameHttpClientResponse
handler(Handler<Buffer> handler)
Set a data handler.int
hashCode()
MultiMap
headers()
NetSocket
netSocket()
static HttpClientResponse
newInstance(HttpClientResponse arg)
HttpClientResponse
pause()
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.Pipe<Buffer>
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .void
pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.void
pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.HttpClientRequest
request()
HttpClientResponse
resume()
Resume reading, and sets the buffer inflowing
mode.io.reactivex.Single<Buffer>
rxBody()
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxEnd()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completesio.reactivex.Completable
rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.int
statusCode()
String
statusMessage()
HttpClientResponse
streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes.io.reactivex.Flowable<Buffer>
toFlowable()
io.reactivex.Observable<Buffer>
toObservable()
String
toString()
MultiMap
trailers()
HttpVersion
version()
-
-
-
Field Detail
-
__TYPE_ARG
public static final TypeArg<HttpClientResponse> __TYPE_ARG
-
-
Constructor Detail
-
HttpClientResponse
public HttpClientResponse(HttpClientResponse delegate)
-
HttpClientResponse
public HttpClientResponse(Object delegate)
-
-
Method Detail
-
getDelegate
public HttpClientResponse getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<Buffer>
- Specified by:
getDelegate
in interfaceStreamBase
-
toObservable
public io.reactivex.Observable<Buffer> toObservable()
- Specified by:
toObservable
in interfaceReadStream<Buffer>
-
toFlowable
public io.reactivex.Flowable<Buffer> toFlowable()
- Specified by:
toFlowable
in interfaceReadStream<Buffer>
-
pipe
public Pipe<Buffer> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream
.- Specified by:
pipe
in interfaceReadStream<Buffer>
- Returns:
- a pipe
-
pipeTo
public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write streamhandler
-
-
pipeTo
public void pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
pipeTo
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream
-
rxPipeTo
public io.reactivex.Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the
handler
will be called with the result.- Specified by:
rxPipeTo
in interfaceReadStream<Buffer>
- Parameters:
dst
- the destination write stream- Returns:
-
fetch
public HttpClientResponse fetch(long amount)
Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
public HttpClientResponse resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public HttpClientResponse exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStream
Set an exception handler on the read stream.- Specified by:
exceptionHandler
in interfaceReadStream<Buffer>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public HttpClientResponse handler(Handler<Buffer> handler)
Description copied from interface:ReadStream
Set a data handler. As data is read, the handler will be called with the data.- Specified by:
handler
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
public HttpClientResponse pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public HttpClientResponse endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStream
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandler
in interfaceReadStream<Buffer>
- Returns:
- a reference to this, so the API can be used fluently
-
netSocket
public NetSocket netSocket()
- Returns:
- a
NetSocket
facade to interact with the HTTP client response.
-
version
public HttpVersion version()
- Returns:
- the version of the response
-
statusCode
public int statusCode()
- Returns:
- the status code of the response
-
statusMessage
public String statusMessage()
- Returns:
- the status message of the response
-
headers
public MultiMap headers()
- Returns:
- the headers
-
getHeader
public String getHeader(String headerName)
Return the first header value with the specified name- Parameters:
headerName
- the header name- Returns:
- the header value
-
getTrailer
public String getTrailer(String trailerName)
Return the first trailer value with the specified name- Parameters:
trailerName
- the trailer name- Returns:
- the trailer value
-
trailers
public MultiMap trailers()
- Returns:
- the trailers
-
bodyHandler
public HttpClientResponse bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.
- Parameters:
bodyHandler
- This handler will be called after all the body has been received- Returns:
-
body
public HttpClientResponse body(Handler<AsyncResult<Buffer>> handler)
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completes- Parameters:
handler
-- Returns:
-
body
public HttpClientResponse body()
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completes- Returns:
-
rxBody
public io.reactivex.Single<Buffer> rxBody()
Same asbody(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.reactivex.core.buffer.Buffer>>)
but with anhandler
called when the operation completes- Returns:
-
end
public void end(Handler<AsyncResult<Void>> handler)
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Parameters:
handler
-
-
end
public void end()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes
-
rxEnd
public io.reactivex.Completable rxEnd()
Same asend(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but with anhandler
called when the operation completes- Returns:
-
customFrameHandler
public HttpClientResponse customFrameHandler(Handler<HttpFrame> handler)
Set an custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.- Parameters:
handler
-- Returns:
- a reference to this, so the API can be used fluently
-
request
public HttpClientRequest request()
- Returns:
- the corresponding request
-
streamPriorityHandler
public HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes. This is not implemented for HTTP/1.x.- Parameters:
handler
- the handler to be called when the stream priority changes- Returns:
-
getHeader
public String getHeader(CharSequence headerName)
Return the first header value with the specified name- Parameters:
headerName
- the header name- Returns:
- the header value
-
newInstance
public static HttpClientResponse newInstance(HttpClientResponse arg)
-
-