Vert.x 4.5.13 · io.vertx.core.http.impl.HttpClientResponseImpl

Modifier and Type	Field and Description
private final HttpConnection	conn
private List<String>	cookies
private Handler<HttpFrame>	customFrameHandler
private HttpEventHandler	eventHandler
private MultiMap	headers
private static final Logger	log
private NetSocket	netSocket
private Handler<StreamPriority>	priorityHandler
private final HttpClientRequestBase	request
private final int	statusCode
private final String	statusMessage
private final HttpClientStream	stream
private MultiMap	trailers
private final HttpVersion	version

Modifier and Type

Field and Description

private final HttpConnection

conn

private List<String>

private Handler<HttpFrame>

customFrameHandler

private HttpEventHandler

eventHandler

private MultiMap

headers

private static final Logger

log

private NetSocket

netSocket

private Handler<StreamPriority>

priorityHandler

private final HttpClientRequestBase

request

private final int

statusCode

private final String

statusMessage

private final HttpClientStream

stream

private MultiMap

trailers

private final HttpVersion

version

Access	Constructor and Description
pack-priv	HttpClientResponseImpl(HttpClientRequestBase request, HttpVersion version, HttpClientStream stream, int statusCode, String statusMessage, MultiMap headers)

Access

Constructor and Description

pack-priv

HttpClientResponseImpl(HttpClientRequestBase request, HttpVersion version, HttpClientStream stream, int statusCode, String statusMessage, MultiMap headers)

Modifier and Type	Method and Description
public Future<Buffer>	body() Implements io.vertx.core.http.HttpClientResponse.body. Convenience method for receiving the entire request body in one piece.
private void	checkEnded()
public List<String>	cookies() Implements io.vertx.core.http.HttpResponseHead.cookies.
public HttpClientResponse	customFrameHandler(Handler<HttpFrame> handler) Implements io.vertx.core.http.HttpClientResponse.customFrameHandler. Set an custom frame handler.
public synchronized Future<Void>	end() Implements io.vertx.core.http.HttpClientResponse.end. Returns a future signaling when the response has been fully received successfully or failed.
public HttpClientResponse	endHandler(Handler<Void> handler) Implements io.vertx.core.http.HttpClientResponse.endHandler.
private HttpEventHandler	eventHandler(boolean create)
public HttpClientResponse	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpClientResponse.exceptionHandler.
public HttpClientResponse	fetch(long amount) Implements io.vertx.core.http.HttpClientResponse.fetch. Fetch the specified `amount` of elements.
public String	getHeader(String the header name headerName) Implements io.vertx.core.http.HttpResponseHead.getHeader. Return the first header value with the specified name
public String	getHeader(CharSequence the header name headerName) Implements io.vertx.core.http.HttpResponseHead.getHeader. Return the first header value with the specified name
public String	getTrailer(String the trailer name trailerName) Implements io.vertx.core.http.HttpClientResponse.getTrailer. Return the first trailer value with the specified name
pack-priv void	handleChunk(Buffer data) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
pack-priv void	handleEnd(MultiMap trailers)
pack-priv void	handleException(Throwable e)
pack-priv void	handlePriorityChange(StreamPriority streamPriority)
public HttpClientResponse	handler(Handler<Buffer> handler) Implements io.vertx.core.http.HttpClientResponse.handler.
pack-priv void	handleUnknownFrame(HttpFrame frame)
public MultiMap	headers() Implements io.vertx.core.http.HttpResponseHead.headers.
public NetSocket	netSocket() Implements io.vertx.core.http.HttpClientResponse.netSocket.
public HttpClientResponse	pause() Implements io.vertx.core.http.HttpClientResponse.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public HttpClientRequestBase	request() Implements io.vertx.core.http.HttpClientResponse.request.
public HttpClientResponse	resume() Implements io.vertx.core.http.HttpClientResponse.resume. Resume reading, and sets the buffer in `flowing` mode.
public int	statusCode() Implements io.vertx.core.http.HttpResponseHead.statusCode.
public String	statusMessage() Implements io.vertx.core.http.HttpResponseHead.statusMessage.
public HttpClientResponse	streamPriorityHandler(Handler<StreamPriority> the handler to be called when the stream priority changes handler) Implements io.vertx.core.http.HttpClientResponse.streamPriorityHandler. Set an handler for stream priority changes.
public MultiMap	trailers() Implements io.vertx.core.http.HttpClientResponse.trailers.
public HttpVersion	version() Implements io.vertx.core.http.HttpResponseHead.version.

Modifier and Type

Method and Description

public Future<Buffer>

body()

Implements io.vertx.core.http.HttpClientResponse.body.

Convenience method for receiving the entire request body in one piece.

private void

checkEnded()

public List<String>

cookies()

Implements io.vertx.core.http.HttpResponseHead.cookies.

public HttpClientResponse

customFrameHandler(Handler<HttpFrame> handler)

Implements io.vertx.core.http.HttpClientResponse.customFrameHandler.

Set an custom frame handler.

public synchronized Future<Void>

end()

Implements io.vertx.core.http.HttpClientResponse.end.

Returns a future signaling when the response has been fully received successfully or failed.

public HttpClientResponse

endHandler(Handler<Void> handler)

Implements io.vertx.core.http.HttpClientResponse.endHandler.

private HttpEventHandler

eventHandler(boolean create)

public HttpClientResponse

exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.http.HttpClientResponse.exceptionHandler.

public HttpClientResponse

fetch(long amount)

Implements io.vertx.core.http.HttpClientResponse.fetch.

Fetch the specified amount of elements.

public String

getHeader(String

the header name

headerName)

Implements io.vertx.core.http.HttpResponseHead.getHeader.

Return the first header value with the specified name

public String

getHeader(CharSequence

the header name

headerName)

Implements io.vertx.core.http.HttpResponseHead.getHeader.

Return the first header value with the specified name

public String

getTrailer(String

the trailer name

trailerName)

Implements io.vertx.core.http.HttpClientResponse.getTrailer.

Return the first trailer value with the specified name

pack-priv void

handleChunk(Buffer data)

References Deprecated Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

pack-priv void

handleEnd(MultiMap trailers)

pack-priv void

handleException(Throwable e)

pack-priv void

handlePriorityChange(StreamPriority streamPriority)

public HttpClientResponse

handler(Handler<Buffer> handler)

Implements io.vertx.core.http.HttpClientResponse.handler.

pack-priv void

handleUnknownFrame(HttpFrame frame)

public MultiMap

headers()

Implements io.vertx.core.http.HttpResponseHead.headers.

public NetSocket

netSocket()

Implements io.vertx.core.http.HttpClientResponse.netSocket.

public HttpClientResponse

pause()

Implements io.vertx.core.http.HttpClientResponse.pause.

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

public HttpClientRequestBase

request()

Implements io.vertx.core.http.HttpClientResponse.request.

public HttpClientResponse

resume()

Implements io.vertx.core.http.HttpClientResponse.resume.

Resume reading, and sets the buffer in flowing mode.

public int

statusCode()

Implements io.vertx.core.http.HttpResponseHead.statusCode.

public String

statusMessage()

Implements io.vertx.core.http.HttpResponseHead.statusMessage.

public HttpClientResponse

streamPriorityHandler(Handler<StreamPriority>

the handler to be called when the stream priority changes

handler)

Implements io.vertx.core.http.HttpClientResponse.streamPriorityHandler.

Set an handler for stream priority changes.

public MultiMap

trailers()

Implements io.vertx.core.http.HttpClientResponse.trailers.

public HttpVersion

version()

Implements io.vertx.core.http.HttpResponseHead.version.

conn	back to summary
private final HttpConnection conn

conn

back to summary

private final HttpConnection conn

back to summary

private List<String> cookies

customFrameHandler	back to summary
private Handler<HttpFrame> customFrameHandler

customFrameHandler

back to summary

private Handler<HttpFrame> customFrameHandler

eventHandler	back to summary
private HttpEventHandler eventHandler

eventHandler

back to summary

private HttpEventHandler eventHandler

headers	back to summary
private MultiMap headers

headers

back to summary

private MultiMap headers

log	back to summary
private static final Logger log

log

back to summary

private static final Logger log

netSocket	back to summary
private NetSocket netSocket

netSocket

back to summary

private NetSocket netSocket

priorityHandler	back to summary
private Handler<StreamPriority> priorityHandler

priorityHandler

back to summary

private Handler<StreamPriority> priorityHandler

request	back to summary
private final HttpClientRequestBase request

request

back to summary

private final HttpClientRequestBase request

statusCode	back to summary
private final int statusCode

statusCode

back to summary

private final int statusCode

statusMessage	back to summary
private final String statusMessage

statusMessage

back to summary

private final String statusMessage

stream	back to summary
private final HttpClientStream stream

stream

back to summary

private final HttpClientStream stream

trailers	back to summary
private MultiMap trailers

trailers

back to summary

private MultiMap trailers

version	back to summary
private final HttpVersion version

version

back to summary

private final HttpVersion version

HttpClientResponseImpl	back to summary
pack-priv HttpClientResponseImpl(HttpClientRequestBase request, HttpVersion version, HttpClientStream stream, int statusCode, String statusMessage, MultiMap headers)

HttpClientResponseImpl

back to summary

pack-priv HttpClientResponseImpl(HttpClientRequestBase request, HttpVersion version, HttpClientStream stream, int statusCode, String statusMessage, MultiMap headers)

Method Detail

body	back to summary
public Future<Buffer> body() Implements io.vertx.core.http.HttpClientResponse.body. Doc from io.vertx.core.http.HttpClientResponse.body. 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. Returns:Future<Buffer> a future completed with the body result Annotations @Override

body

back to summary

public Future<Buffer> body()

Implements io.vertx.core.http.HttpClientResponse.body.

Doc from io.vertx.core.http.HttpClientResponse.body.

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.

Returns:Future<Buffer>

a future completed with the body result

Annotations

@Override

checkEnded	back to summary
private void checkEnded()

back to summary

public List<String> cookies()

Implements io.vertx.core.http.HttpResponseHead.cookies.

Returns:List<String>

Doc from io.vertx.core.http.HttpResponseHead.cookies.

the Set-Cookie headers (including trailers)

Annotations

@Override

customFrameHandler	back to summary
public HttpClientResponse customFrameHandler(Handler<HttpFrame> handler) Implements io.vertx.core.http.HttpClientResponse.customFrameHandler. Doc from io.vertx.core.http.HttpClientResponse.customFrameHandler. 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. Returns:HttpClientResponse a reference to this, so the API can be used fluently Annotations @Override

customFrameHandler

back to summary

public HttpClientResponse customFrameHandler(Handler<HttpFrame> handler)

Implements io.vertx.core.http.HttpClientResponse.customFrameHandler.

Doc from io.vertx.core.http.HttpClientResponse.customFrameHandler.

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.

Returns:HttpClientResponse

a reference to this, so the API can be used fluently

Annotations

@Override

end	back to summary
public synchronized Future<Void> end() Implements io.vertx.core.http.HttpClientResponse.end. Doc from io.vertx.core.http.HttpClientResponse.end. Returns a future signaling when the response has been fully received successfully or failed. Returns:Future<Void> a future completed with the body result Annotations @Override

end

back to summary

public synchronized Future<Void> end()

Implements io.vertx.core.http.HttpClientResponse.end.

Doc from io.vertx.core.http.HttpClientResponse.end.

Returns a future signaling when the response has been fully received successfully or failed.

Returns:Future<Void>

a future completed with the body result

Annotations

@Override

endHandler	back to summary
public HttpClientResponse endHandler(Handler<Void> handler) Implements io.vertx.core.http.HttpClientResponse.endHandler. Annotations @Override

endHandler

back to summary

public HttpClientResponse endHandler(Handler<Void> handler)

Implements io.vertx.core.http.HttpClientResponse.endHandler.

Annotations

@Override

eventHandler	back to summary
private HttpEventHandler eventHandler(boolean create)

exceptionHandler	back to summary
public HttpClientResponse exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.http.HttpClientResponse.exceptionHandler. Annotations @Override

exceptionHandler

back to summary

public HttpClientResponse exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.http.HttpClientResponse.exceptionHandler.

Annotations

@Override

fetch back to summary

fetch	back to summary
public HttpClientResponse fetch(long amount) Implements io.vertx.core.http.HttpClientResponse.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` 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. Returns:HttpClientResponse a reference to this, so the API can be used fluently Annotations @Override

public HttpClientResponse fetch(long amount)

Implements io.vertx.core.http.HttpClientResponse.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified amount 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.

Returns:HttpClientResponse

a reference to this, so the API can be used fluently

Annotations

@Override

getHeader	back to summary
public String getHeader(String headerName) Implements io.vertx.core.http.HttpResponseHead.getHeader. Doc from io.vertx.core.http.HttpResponseHead.getHeader. Return the first header value with the specified name Parameters headerName:String the header name Returns:String the header value Annotations @Override

getHeader

back to summary

public String getHeader(String headerName)

Implements io.vertx.core.http.HttpResponseHead.getHeader.

Doc from io.vertx.core.http.HttpResponseHead.getHeader.

Return the first header value with the specified name

Parameters

headerName:String: the header name

Returns:String

the header value

Annotations

@Override

getHeader	back to summary
public String getHeader(CharSequence headerName) Implements io.vertx.core.http.HttpResponseHead.getHeader. Doc from io.vertx.core.http.HttpResponseHead.getHeader. Return the first header value with the specified name Parameters headerName:CharSequence the header name Returns:String the header value Annotations @Override

getHeader

back to summary

public String getHeader(CharSequence headerName)

Implements io.vertx.core.http.HttpResponseHead.getHeader.

Doc from io.vertx.core.http.HttpResponseHead.getHeader.

Return the first header value with the specified name

Parameters

headerName:CharSequence: the header name

Returns:String

the header value

Annotations

@Override

getTrailer	back to summary
public String getTrailer(String trailerName) Implements io.vertx.core.http.HttpClientResponse.getTrailer. Doc from io.vertx.core.http.HttpClientResponse.getTrailer. Return the first trailer value with the specified name Parameters trailerName:String the trailer name Returns:String the trailer value Annotations @Override

getTrailer

back to summary

public String getTrailer(String trailerName)

Implements io.vertx.core.http.HttpClientResponse.getTrailer.

Doc from io.vertx.core.http.HttpClientResponse.getTrailer.

Return the first trailer value with the specified name

Parameters

trailerName:String: the trailer name

Returns:String

the trailer value

Annotations

@Override

handleChunk	back to summary
pack-priv void handleChunk(Buffer data) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

handleEnd	back to summary
pack-priv void handleEnd(MultiMap trailers)

handleException	back to summary
pack-priv void handleException(Throwable e)

handlePriorityChange	back to summary
pack-priv void handlePriorityChange(StreamPriority streamPriority)

handler	back to summary
public HttpClientResponse handler(Handler<Buffer> handler) Implements io.vertx.core.http.HttpClientResponse.handler. Annotations @Override

handler

back to summary

public HttpClientResponse handler(Handler<Buffer> handler)

Implements io.vertx.core.http.HttpClientResponse.handler.

Annotations

@Override

handleUnknownFrame	back to summary
pack-priv void handleUnknownFrame(HttpFrame frame)

headers	back to summary
public MultiMap headers() Implements io.vertx.core.http.HttpResponseHead.headers. Returns:MultiMap Doc from io.vertx.core.http.HttpResponseHead.headers. the headers Annotations @Override

headers

back to summary

public MultiMap headers()

Implements io.vertx.core.http.HttpResponseHead.headers.

Returns:MultiMap

Doc from io.vertx.core.http.HttpResponseHead.headers.

the headers

Annotations

@Override

netSocket back to summary

netSocket	back to summary
public NetSocket netSocket() Implements io.vertx.core.http.HttpClientResponse.netSocket. Returns:NetSocket Doc from io.vertx.core.http.HttpClientResponse.netSocket. a `NetSocket` facade to interact with the HTTP client response. Annotations @Override

public NetSocket netSocket()

Implements io.vertx.core.http.HttpClientResponse.netSocket.

Returns:NetSocket

Doc from io.vertx.core.http.HttpClientResponse.netSocket.

a NetSocket facade to interact with the HTTP client response.

Annotations

@Override

pause back to summary

pause	back to summary
public HttpClientResponse pause() Implements io.vertx.core.http.HttpClientResponse.pause. Doc from io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, 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`. Returns:HttpClientResponse a reference to this, so the API can be used fluently Annotations @Override

public HttpClientResponse pause()

Implements io.vertx.core.http.HttpClientResponse.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

Pause the ReadStream, 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.

Returns:HttpClientResponse

a reference to this, so the API can be used fluently

Annotations

@Override

request	back to summary
public HttpClientRequestBase request() Implements io.vertx.core.http.HttpClientResponse.request. Returns:HttpClientRequestBase Doc from io.vertx.core.http.HttpClientResponse.request. the corresponding request Annotations @Override

request

back to summary

public HttpClientRequestBase request()

Implements io.vertx.core.http.HttpClientResponse.request.

Returns:HttpClientRequestBase

Doc from io.vertx.core.http.HttpClientResponse.request.

the corresponding request

Annotations

@Override

resume back to summary

resume	back to summary
public HttpClientResponse resume() Implements io.vertx.core.http.HttpClientResponse.resume. Doc from io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode. If the `ReadStream` has been paused, reading will recommence on it. Returns:HttpClientResponse a reference to this, so the API can be used fluently Annotations @Override

public HttpClientResponse resume()

Implements io.vertx.core.http.HttpClientResponse.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:HttpClientResponse

a reference to this, so the API can be used fluently

Annotations

@Override

statusCode	back to summary
public int statusCode() Implements io.vertx.core.http.HttpResponseHead.statusCode. Returns:int Doc from io.vertx.core.http.HttpResponseHead.statusCode. the status code of the response Annotations @Override

statusCode

back to summary

public int statusCode()

Implements io.vertx.core.http.HttpResponseHead.statusCode.

Returns:int

Doc from io.vertx.core.http.HttpResponseHead.statusCode.

the status code of the response

Annotations

@Override

statusMessage	back to summary
public String statusMessage() Implements io.vertx.core.http.HttpResponseHead.statusMessage. Returns:String Doc from io.vertx.core.http.HttpResponseHead.statusMessage. the status message of the response Annotations @Override

statusMessage

back to summary

public String statusMessage()

Implements io.vertx.core.http.HttpResponseHead.statusMessage.

Returns:String

Doc from io.vertx.core.http.HttpResponseHead.statusMessage.

the status message of the response

Annotations

@Override

streamPriorityHandler	back to summary
public HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler) Implements io.vertx.core.http.HttpClientResponse.streamPriorityHandler. Doc from io.vertx.core.http.HttpClientResponse.streamPriorityHandler. Set an handler for stream priority changes. This is not implemented for HTTP/1.x. Parameters handler:Handler<StreamPriority> the handler to be called when the stream priority changes Annotations @Override

streamPriorityHandler

back to summary

public HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler)

Implements io.vertx.core.http.HttpClientResponse.streamPriorityHandler.

Doc from io.vertx.core.http.HttpClientResponse.streamPriorityHandler.

Set an handler for stream priority changes.

This is not implemented for HTTP/1.x.

Parameters

handler:Handler<StreamPriority>: the handler to be called when the stream priority changes

Annotations

@Override

trailers	back to summary
public MultiMap trailers() Implements io.vertx.core.http.HttpClientResponse.trailers. Returns:MultiMap Doc from io.vertx.core.http.HttpClientResponse.trailers. the trailers Annotations @Override

trailers

back to summary

public MultiMap trailers()

Implements io.vertx.core.http.HttpClientResponse.trailers.

Returns:MultiMap

Doc from io.vertx.core.http.HttpClientResponse.trailers.

the trailers

Annotations

@Override

version	back to summary
public HttpVersion version() Implements io.vertx.core.http.HttpResponseHead.version. Returns:HttpVersion Doc from io.vertx.core.http.HttpResponseHead.version. the version of the response Annotations @Override

version

back to summary

public HttpVersion version()

Implements io.vertx.core.http.HttpResponseHead.version.

Returns:HttpVersion

Doc from io.vertx.core.http.HttpResponseHead.version.

the version of the response

Annotations

@Override

public Class HttpClientResponseImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail